a Jekyll theme for publishing code documentation to GitHub pages
See programming pages used to document itself here: https://pixeldroid.github.io/programming-pages/
installation | usage | building | contributing
pixeldroid/programming-pages as your remote theme in
plugins: - jekyll-remote-theme remote_theme: pixeldroid/programming-pages
Follow the Jekyll directions for installing a gem-based theme
- Configure a publishing source for GitHub Pages so GitHub knows where to find your documentation.
If you just want to use the theme, you can stop reading here. The directions below are only useful if you're interested in building the theme from source.
programming pages depends on Jekyll, Semantic UI, and jQuery. The dependencies are all captured and coordinated in the source of this project, but if you want to update a dependency or change its configuration, you'll need to be able to build them from source.
- install jekyll and the github-pages gem:
rake docs open http://localhost:4000/
- ensure you can build semantic ui (requires nodejs, npm, gulp):
- check out the programming-pages branch of the pixeldroid fork of semantic ui
The Semantic UI modules required by this project are declared in
- ensure you can build jQuery (requires nodejs, grunt):
grunt custom:-ajax,-wrap remove_map_comment cp /path/to/jquery/dist/jquery.min.js /path/to/programming-pages/_includes/scripts/jquery/jquery-<version>.custom.min.js
Don't forget to update
assets/site.js with the new filename.
Smaller custom subsets of the jQuery library can be built by excluding unwanted modules. (see https://github.com/jquery/jquery#modules)
This project excludes the following unused modules to reduce file size:
deprecated(for jQuery Address's use of
Pull requests for improved documentation, bug fixes and useful features are all welcome. :gift_heart: