mirror of
https://github.com/treffynnon/sqlstyle.guide.git
synced 2025-03-09 12:49:51 -05:00
31 lines
884 B
Markdown
31 lines
884 B
Markdown
# SQL style guide
|
|
|
|
**[Read the guide](http://www.sqlstyle.guide)**
|
|
|
|
---
|
|
|
|
## General
|
|
|
|
The guide is written in [Markdown][md-lang] and uses [Jekyll][jekyll] via
|
|
[GitHub's Pages][gh-pages] facility to render itself upon pushing to the `gh-pages`
|
|
branch.
|
|
|
|
## Sources
|
|
|
|
The markdown source for the guide can be found in [_includes/sqlstyle.guide.md][md]
|
|
|
|
## Installing for local development
|
|
|
|
There is a Gemfile supplied so you just need to follow the
|
|
[GitHub Pages documentation][gh-pages-help] to install the dependencies.
|
|
|
|
To then run it locally `bundle exec jekyll serve`
|
|
|
|
|
|
|
|
[md-lang]: http://daringfireball.net/projects/markdown/
|
|
[jekyll]: http://jekyllrb.com/
|
|
[gh-pages]: https://pages.github.com/
|
|
[md]: https://github.com/treffynnon/sqlstyle.guide/blob/gh-pages/_includes/sqlstyle.guide.md
|
|
[gh-pages-help]: https://help.github.com/articles/using-jekyll-with-pages/#installing-jekyll
|
|
|