https://github.com/junian/jekyll-jtdocs
Fork of just-the-docs Jekyll Theme
https://github.com/junian/jekyll-jtdocs
Last synced: 4 months ago
JSON representation
Fork of just-the-docs Jekyll Theme
- Host: GitHub
- URL: https://github.com/junian/jekyll-jtdocs
- Owner: junian
- License: mit
- Created: 2025-11-06T00:42:05.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2026-03-07T05:24:02.000Z (4 months ago)
- Last Synced: 2026-03-07T12:58:06.704Z (4 months ago)
- Language: SCSS
- Homepage: http://www.junian.dev/jekyll-jtdocs/
- Size: 8.87 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# jekyll-jtdocs
A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages.
Fork of [just-the-docs](https://just-the-docs.com).
[**See it in action!**](https://www.junian.dev/jekyll-jtdocs)
A video walkthrough of various jekyll-jtdocs features
https://user-images.githubusercontent.com/85418632/211225192-7e5d1116-2f4f-4305-bb9b-437fe47df071.mp4
## About
- Fork of [just-the-docs](https://github.com/just-the-docs/just-the-docs/) with my own addition.
- Check `master` branch for the modifications.
- `main` will be synced with upstream without any modification.
## Installation
### Use as Standard GitHub Pages
Create or edit a `_config.yml` file and add `remote_theme: junian/jekyll-jtdocs`.
For example:
```yaml
title: jekyll-jtdocs
description: A Jekyll theme for documentation. Fork of just-the-docs
remote_theme: junian/jekyll-jtdocs
```
For stability, use a certain version, such as:
```yaml
remote_theme: junian/jekyll-jtdocs@v0.12.0
```
### Use the template
The [jekyll-jtdocs Template] provides the simplest, quickest, and easiest way to create a new website that uses the jekyll-jtdocs theme. To get started with creating a site, just click "[use the template]"!
Note: To use the theme, you do ***not*** need to clone or fork the [jekyll-jtdocs repo]! You should do that only if you intend to browse the theme docs locally, contribute to the development of the theme, or develop a new theme based on jekyll-jtdocs.
You can easily set the site created by the template to be published on [GitHub Pages] – the [template README] file explains how to do that, along with other details.
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^2] And you will be able to deploy your local build to a different platform than GitHub Pages.
More specifically, the created site:
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
Other than that, you're free to customize sites that you create with the template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
### Use as a Ruby Gem
Alternatively, you can install the theme as a Ruby Gem, without creating a new site.
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "just-the-docs"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: just-the-docs
```
And then install all relevant dependencies:
```shell
$ bundle
```
## Usage
[View the documentation][jekyll-jtdocs] for usage information.
## Contributing
Bug reports, proposals of new features, and pull requests are welcome on GitHub at https://github.com/junian/jekyll-jtdocs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
### Submitting code changes:
- Submit an [Issue](https://github.com/junian/jekyll-jtdocs/issues) that motivates the changes, using the appropriate template
- Discuss the proposed changes with other users and the maintainers
- Open a [Pull Request](https://github.com/junian/jekyll-jtdocs/pulls)
- Ensure all CI tests pass
- Provide instructions to check the effect of the changes
- Await code review
### Design and development principles of this theme:
1. As few dependencies as possible
2. No build script needed
3. First class mobile experience
4. Make the content shine
## Development
To set up your environment to develop this theme
- Clone this repo
- Run `npm run install` (or `bundle install`) from the root directory
- Run `npm run serve` (or `bundle exec jekyll serve`) to start Jekyll server
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 this theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be included in the gem.
## License
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
[^2]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
[Jekyll]: https://jekyllrb.com
[jekyll-jtdocs Template]: https://pages-templates.github.io/jekyll-jtdocs/
[jekyll-jtdocs]: https://www.junian.dev/jekyll-jtdocs/
[jekyll-jtdocs repo]: https://github.com/junian/jekyll-jtdocs
[GitHub Pages]: https://pages.github.com/
[Template README]: https://github.com/pages-templates/jekyll-jtdocs/blob/main/README.md
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
[use the template]: https://github.com/pages-templates/jekyll-jtdocs/generate