You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Patrick Marsceill 886654d86d
Add these for a better default jekyll experience
4 years ago
_includes Fix assets 4 years ago
_layouts Add these for a better default jekyll experience 4 years ago
_sass Better layout for when nav is long and scrolls 4 years ago
assets Add done after creating content 4 years ago
bin Add binary 6 years ago
docs Content updates 4 years ago
lib/tasks Add done after creating content 4 years ago
node_modules Initial commit 6 years ago
script fix build script 6 years ago
.gitignore Initial commit 6 years ago
.stylelintrc.json Initial commit 6 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 4 years ago
Gemfile Initial commit 6 years ago
LICENSE.txt Initial commit 6 years ago
README.md Update README.md 4 years ago
Rakefile Add rakefile 6 years ago
_config.yml Annoying bug that 404s on local dev 4 years ago
index.md Content updates 4 years ago
just-the-docs.gemspec Make Rake a runtime dep 4 years ago
package.json Initial commit 6 years ago

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.