1
0
mirror of https://github.com/thangisme/notes.git synced 2024-10-14 09:53:41 -04:00
Go to file
2018-12-16 15:23:33 -05:00
_includes Support 3 levels of pages 2018-11-19 13:28:59 -05:00
_layouts Auto focus main content for keyboard scrolling 2018-12-16 15:22:51 -05:00
_sass Better code scrolling for touch 2018-12-16 15:23:18 -05:00
assets Accidental reversal 2018-12-16 15:23:33 -05:00
bin Add binary 2017-06-09 10:15:15 -04:00
docs Allow pages to be excluded from search 2018-12-16 14:47:41 -05:00
lib/tasks Rake fails when dirs dont exist 2018-10-24 16:34:11 -04:00
script No longer need this build process 2018-11-15 15:49:41 -05:00
_config.yml Exclude package-lock.json from jekyll build 2018-12-16 14:29:35 -05:00
.gitignore Ignore node modules 2018-11-15 16:17:29 -05:00
.stylelintrc.json exclude dark mode manifest 2018-11-18 11:09:18 -05:00
.travis.yml Update bundler version 2018-11-19 10:29:30 -05:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2018-10-22 13:07:17 -04:00
Gemfile Initial commit 2017-03-09 13:16:08 -05:00
index.md Merge branch 'v0.2.0' of github.com:pmarsceill/just-the-docs into dark-mode 2018-11-17 16:25:58 -05:00
just-the-docs.gemspec Bump JTD version numbers 2018-11-29 11:33:43 -05:00
LICENSE.txt Initial commit 2017-03-09 13:16:08 -05:00
package-lock.json Bump JTD version numbers 2018-11-29 11:33:43 -05:00
package.json Bump JTD version numbers 2018-11-29 11:33:43 -05:00
Rakefile Add rakefile 2017-06-04 17:54:54 -04:00
README.md Update README.md 2018-10-26 11:31:38 -04:00

Gem version Build status



Just the Docs

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

See it in action!




jtd

Installation

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

Usage

View the documentation for usage information.

Contributing

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

Development

To set up your environment to develop this theme, run bundle install.

Your theme is setup 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.

License

The theme is available as open source under the terms of the MIT License.