mirror of
https://github.com/thangisme/notes.git
synced 2024-11-06 21:17:23 -05:00
71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
---
|
||
layout: default
|
||
title: Home
|
||
nav_order: 1
|
||
---
|
||
|
||
|
||
# Focus on writing good documentation
|
||
{: .fs-9 }
|
||
|
||
Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub pages.
|
||
{: .fs-6 .fw-300 }
|
||
|
||
[Get started now](#getting-started){: .btn .btn-purple .fs-5 .mb-4 .mb-md-0 .mr-2 } [View it on GitHub](https://github.com/pmarsceill/just-the-docs){: .btn .fs-5 }
|
||
|
||
---
|
||
|
||
## 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 standard 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. _Optional:_ Initialize search data (creates `search-data.json`)
|
||
```bash
|
||
$ bundle exec just-the-docs rake search:init
|
||
```
|
||
3. Run you local Jekyll server
|
||
```bash
|
||
$ jekyll serve
|
||
```
|
||
```bash
|
||
# .. or if you're using a Gemfile (bundler)
|
||
$ bundle exec jekyll serve
|
||
```
|
||
4. Point your web browser to [http://localhost:4000](http://localhost:4000)
|
||
|
||
---
|
||
|
||
## About the project
|
||
|
||
Just the Docs is © 2017 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.
|