This is a Jekyll theme forked from just-the-docs. As of 08/17/2020, it is barely altered from the original. This repo, under this name (bh-just-the-docs-theme) is the source of the remote theme underlying the resource library hosted in the repo called 316ef7d8c202d47efb6d457ebe842927d2cb746d. If the name of this directory is changed, the resource library will break.
There are two ways to serve Jekyll blogs on GitHub Pages. The first is to build the blog locally and then commit it to the associated repo. This requires some familiarity with the command line. The second way is to simply upload the markdown files that make up the blog and point Jekyll to a remote theme. In this second case, it is not necessary to build the site locally: additions can be made simply by uploading markdown files.
To save (comparatively) nontechnical BH employees the trouble of building the blog locally, I've chosen the second path here. Additionally, the original just-the-docs repo is still under development, so changes made by its developer will appear on the pages we are using it as a template for. This problem is solved by forking the original repo and pointing the resource library here as the remote theme.
This will also allow us to continue making design changes to the layout in perpetuity.
A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.
Add this line to your Jekyll site's Gemfile:
gem "just-the-docs"And add this line to your Jekyll site's _config.yml:
theme: just-the-docsAnd then execute:
$ bundle
Or install it yourself as:
$ gem install just-the-docs
View the documentation for usage information.
Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. 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.gemspecandpackage.jsonaccording to semantic versioning.
- As few dependencies as possible
- No build script needed
- First class mobile experience
- Make the content shine
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.