Generate a static Bootstrap+Jekyll website based on a given Readme file.
Demo: https://kilinkis.github.io/readme-jekyll-bootstrap-doc/
- Clone repo
- Replace readme.md file with yours
- In the console, run: ruby md2html.rb (Install dependecies if needed [sudo gem install nokogiri redcarpet ])
- Hydriate config.yml with your variables
- Run jekyll: bundle exec jekyll serve
- When ready to publish, compile jekyll: jekyll build
- (optional) Upload to your server
Q: I updated my readme file and want to update my jekyll as well.
A: Just delete all the content after the </script> tag in index.html and start from step 3.
Q: After compiling, site/index.html won't load scripts and styles.
A: Three words: Not a bug. Jekyll is made like that on puropose. /site is ready to be uploaded and run in a server. For previewing, use localhost (as in step 5)
Q: How can I edit the footer?
A: Edit layouts/default.html
This repo was forked from mistic100's: Jekyll Bootstrap Doc