Jekyll site and themes powered by just-the-docs.
Bug reports and pull requests are welcome on GitHub at https://github.com/pukoframework/pukoframework.github.io. 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.
- Open a Pull Request
- Ensure all CI tests pass
- Await code review
- Bump the version number in
just-the-docs.gemspec
andpackage.json
according to semantic versioning.
To set up your environment to develop this theme, run bundle install
.
Your theme is set up 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 the theme is released, only the files in _layouts
, _includes
, and _sass
tracked with Git will be released.
The theme is available as open source under the terms of the MIT License.