title: Sanskrit documentation theme- README tags: [getting_started]
This is the "Sanskrit" collaborative documentation theme for use with the Jekyll static website generator.
Some notable things you get with this theme (in decreasing order of interest):
Take a look at this very repository for an example!
In particular, note the files that you would need to add / modify as needed:
_config.yml
file.remote_theme: sanskrit-coders/sanskrit-documentation-theme
or theme: sanskrit-documentation-theme
(In which case you'd need to install the theme gem).PS: Installation is not needed if you are using the 'remote-theme' method described above.
Steps:
Gemfile
: gem "sanskrit-documentation-theme"
bundle
Or install it yourself as: gem install sanskrit-documentation-theme
If you are using the remote-theme
method described above, github might not automatically pick up changes made to the theme and regenerate your site. To force github to regenerate your site, a tip from here:
git commit --allow-empty -m "Force rebuild of site"; git push
To experiment with this code, add some sample content and run bundle exec jekyll serve
– this directory is setup just like a Jekyll site!
Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
To set up your environment to develop this theme, run bundle install
.
Your theme is setup just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve
and open your browser at http://localhost:4000
. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in _layouts
, _includes
, _sass
and assets
tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in sanskrit-documentation-theme.gemspec
accordingly.
sanskrit-documentation-theme.gemspec
gem build *.gemspec
gem push *.gem
We fork off the tomjoht/documentation-theme-jekyll theme.
The theme is available as open source under the terms of the MIT License.