mirror of
https://github.com/thangisme/notes.git
synced 2024-07-08 07:14:26 -04:00
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
|
---
|
|||
|
layout: default
|
|||
|
title: Home
|
|||
|
nav_order: 1
|
|||
|
---
|
|||
|
|
|||
|
![Just the Docs](/assets/images/just-the-docs.png){:.img-logo}
|
|||
|
|
|||
|
# A Jekyll theme for documentation
|
|||
|
|
|||
|
Focus on writing good docs, not building a site for it. Just the docs allows you to create your documentation site with a Jekyll theme that is easily hosted on GitHub pages.
|
|||
|
{: .fs-6 .fw-300 }
|
|||
|
|
|||
|
---
|
|||
|
|
|||
|
## Getting started
|
|||
|
### Dependancies
|
|||
|
Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/quickstart/) for more information. Just the Docs requires no special Jekyll plugins and can run on GitHub pages Jekyll compiler.
|
|||
|
|
|||
|
### Installation
|
|||
|
1. Install the Ruby Gem
|
|||
|
```bash
|
|||
|
$ gem install just-the-docs
|
|||
|
```
|
|||
|
```yaml
|
|||
|
# .. or add it to your your Jekyll site’s Gemfile
|
|||
|
gem "just-the-docs"
|
|||
|
```
|
|||
|
2. Add Just the Docs to your Jekyll site’s `config.yml`
|
|||
|
```yaml
|
|||
|
theme: "just-the-docs"
|
|||
|
```
|
|||
|
3. Run you local Jekyll server
|
|||
|
```bash
|
|||
|
$ bundle exec jekyll serve
|
|||
|
```
|
|||
|
4. Point your web browser to [http://localhost:4000](http://localhost:4000)
|
|||
|
|
|||
|
---
|
|||
|
|
|||
|
## About the project
|
|||
|
|
|||
|
Just the Docs is © 2016 by [Patrick Marsceill](http://patrickmarsceill.com).
|
|||
|
|
|||
|
### License
|
|||
|
|
|||
|
Just the Docs is distributed by an [MIT license](https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt).
|
|||
|
|
|||
|
### Contributing
|
|||
|
|
|||
|
When contributing to this repository, please first discuss the change you wish to make via issue,
|
|||
|
email, or any other method with the owners of this repository before making a change. Read more about becoming a contributor in [our GitHub repo][954661c7].
|
|||
|
|
|||
|
[954661c7]: https://github.com/pmarsceill/just-the-docs/tree/master/CONTRIBUTING.md "Contributing.md on Just the Docs GitHub repository"
|
|||
|
|
|||
|
### Code of Conduct
|
|||
|
|
|||
|
Just the Docs is committed to fostering a welcoming community.
|
|||
|
|
|||
|
[View our Code of Conduct](https://github.com/pmarsceill/just-the-docs/tree/master/CODE_OF_CONDUCT.md) on our GitHub repository.
|