Go to file
Patrick Marsceill 4177f965df
Content updates
2018-10-24 14:06:41 -04:00
_includes Fix assets 2018-10-22 17:17:46 -04:00
_layouts Fix up search bar on mobile 2018-10-24 14:05:29 -04:00
_sass Better layout for when nav is long and scrolls 2018-10-24 14:06:12 -04:00
assets Add done after creating content 2018-10-23 13:09:23 -04:00
bin Add binary 2017-06-09 10:15:15 -04:00
docs Content updates 2018-10-24 14:06:41 -04:00
lib/tasks Add done after creating content 2018-10-23 13:09:23 -04:00
node_modules Initial commit 2017-03-09 13:16:08 -05:00
script fix build script 2017-04-09 16:09:24 -04:00
.gitignore Initial commit 2017-03-09 13:16:08 -05:00
.stylelintrc.json Initial commit 2017-03-09 13:16:08 -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
LICENSE.txt Initial commit 2017-03-09 13:16:08 -05:00
README.md Update README.md 2018-10-23 15:08:56 -04:00
Rakefile Add rakefile 2017-06-04 17:54:54 -04:00
_config.yml Annoying bug that 404s on local dev 2018-10-24 14:05:42 -04:00
index.md Content updates 2018-10-24 14:06:41 -04:00
just-the-docs.gemspec Make Rake a runtime dep 2018-10-24 12:56:33 -04:00
package.json Initial commit 2017-03-09 13:16:08 -05:00

README.md

Just the Docs

A nice looking, high customizable, responsive Jekyll theme for documention with built-in search. Easily hosted on GitHub pages.

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.

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.

When your changes are ready:

  • Open a Pull Request
  • Await code review
  • Bump the version number in just-the-docs.gemspec
  • Run script/build to package the gem
  • Run gem push just-the-docs-<version>.gem to publish the gem to Rubygems.org

License

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