mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-09-17 14:43:32 -06:00
Make spacing consistent
This commit is contained in:
8
index.md
8
index.md
@@ -6,7 +6,6 @@ description: "Just the Docs is a responsive Jekyll theme with built-in search th
|
||||
permalink: /
|
||||
---
|
||||
|
||||
|
||||
# Focus on writing good documentation
|
||||
{: .fs-9 }
|
||||
|
||||
@@ -18,10 +17,13 @@ Just the Docs gives your documentation a jumpstart with a responsive Jekyll them
|
||||
---
|
||||
|
||||
## Getting started
|
||||
|
||||
### Dependencies
|
||||
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.
|
||||
|
||||
|
||||
### Quick start: Use as a GitHub Pages remote theme
|
||||
|
||||
1. Add Just the Docs to your Jekyll site's `_config.yml` as a [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/)
|
||||
```yaml
|
||||
remote_theme: pmarsceill/just-the-docs
|
||||
@@ -29,6 +31,7 @@ remote_theme: pmarsceill/just-the-docs
|
||||
<small>You must have GitHub pages enabled on your repo, one or more markdown files, and a `_config.yml` file. [See an example repository](https://github.com/pmarsceill/jtd-remote)</small>
|
||||
|
||||
### Local installation: Use the gem-based theme
|
||||
|
||||
1. Install the Ruby Gem
|
||||
```bash
|
||||
$ gem install just-the-docs
|
||||
@@ -56,8 +59,8 @@ $ bundle exec jekyll serve
|
||||
4. Point your web browser to [http://localhost:4000](http://localhost:4000)
|
||||
|
||||
### Configure Just the Docs
|
||||
- [See configuration options]({{ site.baseurl }}{% link docs/configuration.md %})
|
||||
|
||||
- [See configuration options]({{ site.baseurl }}{% link docs/configuration.md %})
|
||||
|
||||
---
|
||||
|
||||
@@ -74,7 +77,6 @@ Just the Docs is distributed by an [MIT license](https://github.com/pmarsceill/j
|
||||
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](https://github.com/pmarsceill/just-the-docs#contributing).
|
||||
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
Just the Docs is committed to fostering a welcoming community.
|
||||
|
Reference in New Issue
Block a user