Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
 
 
 
 
 
Luigi Cruz 602bff7cd8 Rebase Repository há 4 anos
..
_includes Rebase Repository há 4 anos
_layouts Rebase Repository há 4 anos
_sass Rebase Repository há 4 anos
assets Rebase Repository há 4 anos
bin Rebase Repository há 4 anos
docs Rebase Repository há 4 anos
lib/tasks Rebase Repository há 4 anos
script Rebase Repository há 4 anos
.stylelintrc.json Rebase Repository há 4 anos
404.html Rebase Repository há 4 anos
CNAME Rebase Repository há 4 anos
CODE_OF_CONDUCT.md Rebase Repository há 4 anos
Gemfile Rebase Repository há 4 anos
LICENSE.txt Rebase Repository há 4 anos
README.md Rebase Repository há 4 anos
Rakefile Rebase Repository há 4 anos
_config.yml Rebase Repository há 4 anos
favicon.ico Rebase Repository há 4 anos
index.md Rebase Repository há 4 anos
just-the-docs.gemspec Rebase Repository há 4 anos
package-lock.json Rebase Repository há 4 anos
package.json Rebase Repository há 4 anos

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.