mirror of
https://github.com/thangisme/notes.git
synced 2024-10-31 21:07:23 -04:00
59 lines
2.0 KiB
Markdown
59 lines
2.0 KiB
Markdown
# Just the Docs
|
|
|
|
A nice looking, high customizable, responsive Jekyll theme for documention with built-in search. Easily hosted on GitHub pages.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Add this line to your Jekyll site's Gemfile:
|
|
|
|
```ruby
|
|
gem "just-the-docs"
|
|
```
|
|
|
|
And add this line to your Jekyll site's `_config.yml`:
|
|
|
|
```yaml
|
|
theme: just-the-docs
|
|
```
|
|
|
|
And then execute:
|
|
|
|
$ bundle
|
|
|
|
Or install it yourself as:
|
|
|
|
$ gem install just-the-docs
|
|
|
|
## Usage
|
|
|
|
[View the documentation](https://pmarsceill.github.io/just-the-docs/) 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](http://contributor-covenant.org) 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](https://github.com/pmarsceill/just-the-docs/pulls)
|
|
- 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](http://opensource.org/licenses/MIT).
|
|
|