Standardized all text files on markdown and set all their extensions to the shortform
This commit is contained in:
parent
c688ee67b6
commit
570079bbb8
|
@ -0,0 +1,45 @@
|
||||||
|
# Jekyll
|
||||||
|
|
||||||
|
[](https://travis-ci.org/mojombo/jekyll)
|
||||||
|
[](https://codeclimate.com/github/mojombo/jekyll)
|
||||||
|
|
||||||
|
By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!
|
||||||
|
|
||||||
|
Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind [GitHub Pages](http://pages.github.com), which you can use to host your project's page or blog right here from GitHub.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
* [Install](http://jekyllrb.com/docs/installation/) the gem
|
||||||
|
* Read up about its [Usage](http://jekyllrb.com/docs/usage/) and [Configuration](http://jekyllrb.com/docs/configuration/)
|
||||||
|
* Take a gander at some existing [Sites](http://wiki.github.com/mojombo/jekyll/sites)
|
||||||
|
* Fork and [Contribute](https://github.com/mojombo/jekyll/blob/master/CONTRIBUTING.md) your own modifications
|
||||||
|
* Have questions? Post them on the [Mailing List](http://groups.google.com/group/jekyll-rb)
|
||||||
|
|
||||||
|
## Diving In
|
||||||
|
|
||||||
|
* [Migrate](http://jekyllrb.com/docs/migrations/) from your previous system
|
||||||
|
* Learn how the [YAML Front Matter](http://jekyllrb.com/docs/frontmatter/) works
|
||||||
|
* Put information on your site with [Variables](http://jekyllrb.com/docs/variables/)
|
||||||
|
* Customize the [Permalinks](http://jekyllrb.com/docs/permalinks/) your posts are generated with
|
||||||
|
* Use the built-in [Liquid Extensions](http://jekyllrb.com/docs/templates/) to make your life easier
|
||||||
|
* Use custom [Plugins](http://jekyllrb.com/docs/plugins/) to generate content specific to your site
|
||||||
|
|
||||||
|
## Runtime Dependencies
|
||||||
|
|
||||||
|
* Classifier: Generating related posts (Ruby)
|
||||||
|
* Directory Watcher: Auto-regeneration of sites (Ruby)
|
||||||
|
* Kramdown: Markdown-superset converter (Ruby)
|
||||||
|
* Liquid: Templating system (Ruby)
|
||||||
|
* Maruku: Default markdown engine (Ruby)
|
||||||
|
|
||||||
|
## Developer Dependencies
|
||||||
|
|
||||||
|
* RDiscount: Discount Markdown Processor (Ruby)
|
||||||
|
* RedCloth: Textile support (Ruby)
|
||||||
|
* RedGreen: Nicer test output (Ruby)
|
||||||
|
* RR: Mocking (Ruby)
|
||||||
|
* Shoulda: Test framework (Ruby)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
See [LICENSE](https://github.com/mojombo/jekyll/blob/master/LICENSE).
|
|
@ -1,45 +0,0 @@
|
||||||
h1. Jekyll
|
|
||||||
|
|
||||||
!https://travis-ci.org/mojombo/jekyll.png?branch=master!:https://travis-ci.org/mojombo/jekyll
|
|
||||||
"!https://codeclimate.com/github/mojombo/jekyll.png!":https://codeclimate.com/github/mojombo/jekyll
|
|
||||||
|
|
||||||
By Tom Preston-Werner, Nick Quaranto, and many awesome contributors!
|
|
||||||
|
|
||||||
Jekyll is a simple, blog aware, static site generator. It takes a template directory (representing the raw form of a website), runs it through Textile or Markdown and Liquid converters, and spits out a complete, static website suitable for serving with Apache or your favorite web server. This is also the engine behind "GitHub Pages":http://pages.github.com, which you can use to host your project's page or blog right here from GitHub.
|
|
||||||
|
|
||||||
h2. Getting Started
|
|
||||||
|
|
||||||
* "Install":http://jekyllrb.com/docs/installation/ the gem
|
|
||||||
* Read up about its "Usage":http://jekyllrb.com/docs/usage/ and "Configuration":http://jekyllrb.com/docs/configuration/
|
|
||||||
* Take a gander at some existing "Sites":http://wiki.github.com/mojombo/jekyll/sites
|
|
||||||
* Fork and "Contribute":https://github.com/mojombo/jekyll/blob/master/CONTRIBUTING.md your own modifications
|
|
||||||
* Have questions? Post them on the "Mailing List":http://groups.google.com/group/jekyll-rb
|
|
||||||
|
|
||||||
h2. Diving In
|
|
||||||
|
|
||||||
* "Migrate":http://jekyllrb.com/docs/migrations/ from your previous system
|
|
||||||
* Learn how the "YAML Front Matter":http://jekyllrb.com/docs/frontmatter/ works
|
|
||||||
* Put information on your site with "Variables":http://jekyllrb.com/docs/variables/
|
|
||||||
* Customize the "Permalinks":http://jekyllrb.com/docs/permalinks/ your posts are generated with
|
|
||||||
* Use the built-in "Liquid Extensions":http://jekyllrb.com/docs/templates/ to make your life easier
|
|
||||||
* Use custom "Plugins":http://jekyllrb.com/docs/plugins/ to generate content specific to your site
|
|
||||||
|
|
||||||
h2. Runtime Dependencies
|
|
||||||
|
|
||||||
* Classifier: Generating related posts (Ruby)
|
|
||||||
* Directory Watcher: Auto-regeneration of sites (Ruby)
|
|
||||||
* Kramdown: Markdown-superset converter (Ruby)
|
|
||||||
* Liquid: Templating system (Ruby)
|
|
||||||
* Maruku: Default markdown engine (Ruby)
|
|
||||||
|
|
||||||
h2. Developer Dependencies
|
|
||||||
|
|
||||||
* RDiscount: Discount Markdown Processor (Ruby)
|
|
||||||
* RedCloth: Textile support (Ruby)
|
|
||||||
* RedGreen: Nicer test output (Ruby)
|
|
||||||
* RR: Mocking (Ruby)
|
|
||||||
* Shoulda: Test framework (Ruby)
|
|
||||||
|
|
||||||
h2. License
|
|
||||||
|
|
||||||
See "LICENSE":https://github.com/mojombo/jekyll/blob/master/LICENSE.
|
|
Loading…
Reference in New Issue