Non puoi selezionare più di 25 argomenti Gli argomenti devono iniziare con una lettera o un numero, possono includere trattini ('-') e possono essere lunghi fino a 35 caratteri.

README.md 2.7 KiB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. <p align="right">
  2. <a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/pmarsceill/just-the-docs/actions"><img src="https://github.com/pmarsceill/just-the-docs/workflows/CI/badge.svg" alt="Build status"></a>
  3. </p>
  4. <br><br>
  5. <p align="center">
  6. <h1 align="center">Just the Docs</h1>
  7. <p align="center">A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
  8. <p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
  9. <br><br><br>
  10. </p>
  11. ![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif)
  12. ## Installation
  13. Add this line to your Jekyll site's Gemfile:
  14. ```ruby
  15. gem "just-the-docs"
  16. ```
  17. And add this line to your Jekyll site's `_config.yml`:
  18. ```yaml
  19. theme: just-the-docs
  20. ```
  21. And then execute:
  22. $ bundle
  23. Or install it yourself as:
  24. $ gem install just-the-docs
  25. ## Usage
  26. [View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
  27. ## Contributing
  28. 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](http://contributor-covenant.org) code of conduct.
  29. ### Submitting code changes:
  30. - Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
  31. - Ensure all CI tests pass
  32. - Await code review
  33. - Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
  34. ### Design and development principles of this theme:
  35. 1. As few dependencies as possible
  36. 2. No build script needed
  37. 3. First class mobile experience
  38. 4. Make the content shine
  39. ## Development
  40. To set up your environment to develop this theme, run `bundle install`.
  41. 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.
  42. When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
  43. ## License
  44. The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).