Skip to content
Snippets Groups Projects
Commit 79f30a22 authored by Patrick Marsceill's avatar Patrick Marsceill Committed by GitHub
Browse files

fix prettier bugs, remove prettier from MD formatting

parent 13298d20
No related branches found
No related tags found
No related merge requests found
...@@ -7,3 +7,4 @@ assets/css/just-the-docs-dark.scss ...@@ -7,3 +7,4 @@ assets/css/just-the-docs-dark.scss
assets/js/vendor/lunr.min.js assets/js/vendor/lunr.min.js
assets/js/search-data.json assets/js/search-data.json
assets/js/just-the-docs.js assets/js/just-the-docs.js
*.md
...@@ -4,5 +4,4 @@ ...@@ -4,5 +4,4 @@
"singleQuote": false, "singleQuote": false,
"tabWidth": 2, "tabWidth": 2,
"trailingComma": "es5" "trailingComma": "es5"
} }
\ No newline at end of file
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
<p align="center"> <p align="center">
<h1 align="center">Just the Docs</h1> <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">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> <br><br><br>
</p> </p>
...@@ -39,7 +39,7 @@ Alternatively, you can run it inside Docker while developing your site ...@@ -39,7 +39,7 @@ Alternatively, you can run it inside Docker while developing your site
## Usage ## 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 ## Contributing
......
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
title: Just the Docs title: Just the Docs
description: A Jekyll theme for documentation description: A Jekyll theme for documentation
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog 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 permalink: pretty
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile" 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 ...@@ -5,18 +5,16 @@ nav_order: 2
--- ---
# Configuration # Configuration
{: .no_toc } {: .no_toc }
Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's \_config.yml file. Just the Docs has some specific configuration parameters that can be defined in your Jekyll site's \_config.yml file.
{: .fs-6 .fw-300 } {: .fs-6 .fw-300 }
## Table of contents ## Table of contents
{: .no_toc .text-delta } {: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}
--- ---
......
...@@ -5,15 +5,13 @@ nav_order: 6 ...@@ -5,15 +5,13 @@ nav_order: 6
--- ---
# Customization # Customization
{: .no_toc } {: .no_toc }
## Table of contents ## Table of contents
{: .no_toc .text-delta } {: .no_toc .text-delta }
1. TOC 1. TOC
{:toc} {:toc}
--- ---
...@@ -29,7 +27,6 @@ Just the Docs supports two color schemes: light (default), and dark. ...@@ -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: To enable a color scheme, set the `color_scheme` parameter in your site's `_config.yml` file:
#### Example #### Example
{: .no_toc } {: .no_toc }
```yaml ```yaml
...@@ -66,7 +63,6 @@ Available variables are listed in the [\_variables.scss](https://github.com/just ...@@ -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: For example, to change the link color from the purple default to blue, include the following inside your scheme file:
#### Example #### Example
{: .no_toc } {: .no_toc }
```scss ```scss
...@@ -87,13 +83,12 @@ color_scheme: foo ...@@ -87,13 +83,12 @@ color_scheme: foo
### Switchable custom scheme ### 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) 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 %} {% raw %}
---
--- ---
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
{% include css/just-the-docs.scss.liquid color_scheme="foo" %}
{% endraw %} {% endraw %}
This allows you to switch the scheme via the following javascript. 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 ...@@ -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. For example, if you'd like to add your own styles for printing a page, you could add the following styles.
#### Example #### Example
{: .no_toc } {: .no_toc }
```scss ```scss
......
...@@ -6,8 +6,7 @@ description: "Just the Docs is a responsive Jekyll theme with built-in search th ...@@ -6,8 +6,7 @@ description: "Just the Docs is a responsive Jekyll theme with built-in search th
permalink: / permalink: /
--- ---
# Focus on writing good documentation # Focus on writing good documentation.
{: .fs-9 } {: .fs-9 }
Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages. Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment