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.
 
 
 
 
 
Luigi Cruz 1a9808a2cf Update Index page. 4 年之前
..
_includes Rebase Repository 4 年之前
_layouts Rebase Repository 4 年之前
_sass Rebase Repository 4 年之前
assets Rebase Repository 4 年之前
bin Rebase Repository 4 年之前
docs Rebase Repository 4 年之前
lib/tasks Rebase Repository 4 年之前
script Rebase Repository 4 年之前
.stylelintrc.json Rebase Repository 4 年之前
404.html Rebase Repository 4 年之前
CNAME Rebase Repository 4 年之前
CODE_OF_CONDUCT.md Rebase Repository 4 年之前
Gemfile Rebase Repository 4 年之前
LICENSE.txt Rebase Repository 4 年之前
README.md Rebase Repository 4 年之前
Rakefile Rebase Repository 4 年之前
_config.yml Rebase Repository 4 年之前
favicon.ico Rebase Repository 4 年之前
index.md Update Index page. 4 年之前
just-the-docs.gemspec Rebase Repository 4 年之前
package-lock.json Rebase Repository 4 年之前
package.json Rebase Repository 4 年之前

README.md

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!




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

License

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