mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-05 11:41:22 -06:00
fix prettier bugs, remove prettier from MD formatting
This commit is contained in:
parent
13298d20c0
commit
79f30a22bc
@ -7,3 +7,4 @@ assets/css/just-the-docs-dark.scss
|
||||
assets/js/vendor/lunr.min.js
|
||||
assets/js/search-data.json
|
||||
assets/js/just-the-docs.js
|
||||
*.md
|
||||
|
@ -4,5 +4,4 @@
|
||||
"singleQuote": false,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "es5"
|
||||
}
|
||||
|
||||
}
|
@ -5,7 +5,7 @@
|
||||
<p align="center">
|
||||
<h1 align="center">Just the Docs</h1>
|
||||
<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>
|
||||
<p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
|
||||
<p align="center"><strong><a href="https://just-the-docs.github.io/just-the-docs/">See it in action!</a></strong></p>
|
||||
<br><br><br>
|
||||
</p>
|
||||
|
||||
@ -39,7 +39,7 @@ Alternatively, you can run it inside Docker while developing your site
|
||||
|
||||
## Usage
|
||||
|
||||
[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
|
||||
[View the documentation](https://just-the-docs.github.io/just-the-docs/) for usage information.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
@ -16,7 +16,7 @@
|
||||
title: Just the Docs
|
||||
description: A Jekyll theme for documentation
|
||||
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
|
||||
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
url: "https://just-the-docs.github.io" # the base hostname & protocol for your site, e.g. http://example.com
|
||||
|
||||
permalink: pretty
|
||||
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"
|
||||
|
@ -5,18 +5,16 @@ nav_order: 2
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's \_config.yml file.
|
||||
{: .fs-6 .fw-300 }
|
||||
|
||||
## Table of contents
|
||||
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
1. TOC
|
||||
{:toc}
|
||||
{:toc}
|
||||
|
||||
---
|
||||
|
||||
|
@ -5,15 +5,13 @@ nav_order: 6
|
||||
---
|
||||
|
||||
# Customization
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
## Table of contents
|
||||
|
||||
{: .no_toc .text-delta }
|
||||
|
||||
1. TOC
|
||||
{:toc}
|
||||
{:toc}
|
||||
|
||||
---
|
||||
|
||||
@ -29,7 +27,6 @@ Just the Docs supports two color schemes: light (default), and dark.
|
||||
To enable a color scheme, set the `color_scheme` parameter in your site's `_config.yml` file:
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```yaml
|
||||
@ -66,7 +63,6 @@ Available variables are listed in the [\_variables.scss](https://github.com/just
|
||||
For example, to change the link color from the purple default to blue, include the following inside your scheme file:
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```scss
|
||||
@ -87,13 +83,12 @@ color_scheme: foo
|
||||
### Switchable custom scheme
|
||||
|
||||
If you want to be able to change the scheme dynamically, for example via javascript, just add a file `assets/css/just-the-docs-foo.scss` (replace `foo` by your scheme name)
|
||||
with the following content:`
|
||||
with the following content:
|
||||
|
||||
## {% raw %}
|
||||
|
||||
---
|
||||
|
||||
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
|
||||
{% raw %}
|
||||
---
|
||||
---
|
||||
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
|
||||
{% endraw %}
|
||||
|
||||
This allows you to switch the scheme via the following javascript.
|
||||
@ -112,7 +107,6 @@ This will allow for all overrides to be kept in a single file, and for any upstr
|
||||
For example, if you'd like to add your own styles for printing a page, you could add the following styles.
|
||||
|
||||
#### Example
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
```scss
|
||||
|
3
index.md
3
index.md
@ -6,8 +6,7 @@ description: "Just the Docs is a responsive Jekyll theme with built-in search th
|
||||
permalink: /
|
||||
---
|
||||
|
||||
# Focus on writing good documentation
|
||||
|
||||
# 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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user