mirror of https://github.com/thangisme/notes.git synced 2024-06-22 12:05:36 +00:00
Go to file
2020-12-15 20:29:18 +07:00
_includes Add Cloudflare Analytics 2020-12-15 20:04:44 +07:00
_layouts Merge pull request #334 from CodeSandwich/custom_header_footer 2020-10-12 12:57:25 -04:00
_sass I meant auto... oops 2020-10-12 13:20:01 -04:00
.github Update publish-gem.yml 2020-10-14 13:23:05 -04:00
assets Added just-the-docs.collections nav_exclude and search_exclude 2020-07-10 19:07:01 +02:00
bin Update _config.yml with default values 2020-06-25 23:19:24 +02:00
docs Initial Draft 2020-12-14 12:38:40 +07:00
lib/tasks Merge pull request #379 from SgtSilvio/feature/doc-collections 2020-08-10 10:42:30 -04:00
script No longer need this build process 2018-11-15 15:49:41 -05:00
_config.yml Update _config.yml 2020-12-15 20:29:18 +07:00
.gitignore Add .ruby-version to gitignore 2020-04-29 14:38:06 -04:00
.prettierignore update prettierignore 2020-04-24 15:55:07 -04:00
.prettierrc lets just use prettier and forget about it :D) 2020-04-24 15:17:14 -04:00
.stylelintrc.json 🎨 Prettier 2020-04-24 19:55:49 +00:00
404.html Ensure pages with nav_exclude are ignored by navigation 2020-08-10 15:58:42 +02:00
CNAME Create CNAME 2020-12-15 19:29:16 +07:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-10-22 13:07:17 -04:00
docker-compose.yml run the site locally inside docker container 2020-07-28 17:31:49 +03:00
Dockerfile run the site locally inside docker container 2020-07-28 17:31:49 +03:00
favicon.ico Favicon file 2019-05-13 16:40:14 -04:00
Gemfile Initial commit 2017-03-09 13:16:08 -05:00
index.md Initial Draft 2020-12-14 12:38:40 +07:00
just-the-docs.gemspec Update just-the-docs.gemspec 2020-12-15 14:20:59 +07:00
LICENSE.txt Initial commit 2017-03-09 13:16:08 -05:00
package-lock.json Merge pull request #451 from pmarsceill/dependabot/npm_and_yarn/stylelint-config-primer-9.2.1 2020-10-12 12:42:27 -04:00
package.json Update package.json 2020-10-14 13:21:02 -04:00
Rakefile Restored search.rake 2020-06-18 22:39:58 +02:00
README.md run the site locally inside docker container 2020-07-28 17:31:49 +03:00

Gem version Build status

Just the Docs

A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

See it in action!



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-docs

And then execute:

$ bundle

Or install it yourself as:

$ gem install just-the-docs

Alternatively, you can run it inside Docker while developing your site

$ docker-compose up


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.

Submitting code changes:

  • Open a Pull Request
  • Ensure all CI tests pass
  • Await code review
  • Bump the version number in just-the-docs.gemspec and package.json according to semantic versioning.

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


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.