diff --git a/.prettierignore b/.prettierignore index 5dc073f5a8f3aa8fdb28879e48ca68cc8e76a7e7..692aa342ebface613fa395bb6205ffcef614b16b 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 284e842b027a9ef2501ce69f31bb09e5297b8f60..70175ce150ccda1fc61eeb3f4ba4308438ca8cb6 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 a9a0046f097b43fc51f2664350bef580b99cb5aa..16b6ab267b808397e03aca139cefad5bc8c6b1a2 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 7e8b7d9544b70259e80e865c30e173b51eccf175..dbe742f2f73981f43aa3f2c8d41b19fc4e595591 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 400ab09a35ef33a307faa25446fc3b5758bc7ad0..b11f448fe0c462aa707ce181ea42071e68f13b9a 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 f42f58b44d757fe3d939f953be6981b3574e9dd9..075e30d9a957ea43df1b051a806fd2de99d71e73 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 4f8f941591e2b751800afd4a045d5ab9f57d544f..c8e688fd26d400d915af77494cfb799a4f6441bb 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.