Menu
I am writting a documentation for my project. I have done my project in python. But I choose jekyll to write down the documentation. But I didn't found any helpful documentation. There is lots of basic question still moving around me. Such as how to generate template in jekyll etc. Guys please suggest me any help full documentation or share your idea on documentation using jkeyll.
469
Jekyll is a free and open source static site generator. Like a content management system (for example, Drupal and WordPress), Jekyll can be used to build websites with rich and easy-to-use navigation.
Your site is automatically generated by GitHub Pages when you push your source files. Note that GitHub Pages works equally well for regular HTML content, simply because Jekyll treats files without front matter as static assets. So if you only need to push generated HTML, you're good to go without any further setup.
As GitHub has native support for Jekyll, it can convert your documentation into HTML and deploy it on the github.io URL of your project. Do the following to set up the GitHub Pages website of your project: Click Pages on the menu on the left edge of page.
Jekyll is a popular tool for generating static websites from markdown-like text. Given below are some information useful for when you want to update documentation in a project that uses Jekyll.
And also, Jekyll posts and pages can be written in easily readable markups like markdown, text, textile (not supported anymore after Jekyll 3.0 update) etc., Jekyll is simple if you understand what feature is for what purpose. Let us look at the folder structure of Jekyll. The below tree is taken directly from Jekyll documentation.
If you are just starting off with Jekyll or you do not know how to use Jekyll then please start with the official documentation provided by Jekyll. This will set you on the right track. It has a lot of information (and a lot of pages as well).
Now in 2014 there are some templates, I'm looking at
2015 adding:
I think there should be others, but don't know.
115
I'm developing a jekyll theme for tech docs here: https://github.com/tomjohnson1492/documentation-theme-jekyll.
38
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
