From 79f30a22bc076feccf215e8ed41c4c081e354d1e Mon Sep 17 00:00:00 2001
From: Patrick Marsceill <pmarsceill@users.noreply.github.com>
Date: Thu, 3 Mar 2022 19:32:25 +0000
Subject: [PATCH] fix prettier bugs, remove prettier from MD formatting
---
.prettierignore | 1 +
.prettierrc | 3 +--
README.md | 4 ++--
_config.yml | 2 +-
docs/configuration.md | 4 +---
docs/customization.md | 18 ++++++------------
index.md | 3 +--
7 files changed, 13 insertions(+), 22 deletions(-)
diff --git a/.prettierignore b/.prettierignore
index 5dc073f5..692aa342 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -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
diff --git a/.prettierrc b/.prettierrc
index 284e842b..70175ce1 100644
--- a/.prettierrc
+++ b/.prettierrc
@@ -4,5 +4,4 @@
"singleQuote": false,
"tabWidth": 2,
"trailingComma": "es5"
-}
-
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index a9a0046f..16b6ab26 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/_config.yml b/_config.yml
index 7e8b7d95..dbe742f2 100644
--- a/_config.yml
+++ b/_config.yml
@@ -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"
diff --git a/docs/configuration.md b/docs/configuration.md
index 400ab09a..b11f448f 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -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}
---
diff --git a/docs/customization.md b/docs/customization.md
index f42f58b4..075e30d9 100644
--- a/docs/customization.md
+++ b/docs/customization.md
@@ -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
diff --git a/index.md b/index.md
index 4f8f9415..c8e688fd 100644
--- a/index.md
+++ b/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.
--
GitLab