From ff49d02f83d3a07a08d3aa0dc0351f2442f5ac61 Mon Sep 17 00:00:00 2001
From: EricFromCanada
` element, Just the Docs "SFMono-Regular", Menlo, Consolas, Monospace ``` -ABCDEFGHIJKLMNOPQRSTUVWXYZ +ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz {: .fs-5 .ls-10 .text-mono .code-example } @@ -51,7 +51,7 @@ Just the docs uses a responsive type scale that shifts depending on the viewport | `h3`, `.text-gamma` | 16px | 18px | | `h4`, `.text-delta` | 14px | 16px | | `h5`, `.text-epsilon` | 16px | 18px | -| `h6`, `.text-zeta ` | 18px | 24px | +| `h6`, `.text-zeta` | 18px | 24px | | `body` | 14px | 16px | --- diff --git a/docs/utilities/color.md b/docs/utilities/color.md index f025f91..79b3529 100644 --- a/docs/utilities/color.md +++ b/docs/utilities/color.md @@ -6,7 +6,7 @@ parent: Utilities --- # Color Utilities -{:.no_toc} +{: .no_toc } ## Table of contents {: .no_toc .text-delta } diff --git a/docs/utilities/layout.md b/docs/utilities/layout.md index a1b564e..ac03f7e 100644 --- a/docs/utilities/layout.md +++ b/docs/utilities/layout.md @@ -7,7 +7,7 @@ has_children: true --- # Layout Utilities -{:.no_toc} +{: .no_toc } ## Table of contents {: .no_toc .text-delta } @@ -65,7 +65,6 @@ This paragraph will have a margin bottom of 1rem/16px at large screens. This paragraph will have 2rem/32px of padding on the right and left at all screen sizes. {: .px-6 } - ``` ## Vertical Alignment @@ -111,5 +110,4 @@ These headings will be `inline-block`: ### heading 3 { .d-inline-block } - ``` diff --git a/docs/utilities/typography.md b/docs/utilities/typography.md index a517384..7d7a86d 100644 --- a/docs/utilities/typography.md +++ b/docs/utilities/typography.md @@ -6,7 +6,7 @@ parent: Utilities --- # Typography Utilities -{:.no_toc} +{: .no_toc } ## Table of contents {: .no_toc .text-delta } @@ -117,33 +117,31 @@ Use the `lh-` classes to explicitly apply line height to text. | `.lh-tight` | 1.1 | Default for headings | | `.lh-default` | 1.4 | Default for body (paragraphs) | - --No Line height +No Line height No Line height {: .lh-0 } -Tight line height +Tight line height Tight line height {: .lh-tight } -Default line height +Default line height Default line height {: .fh-default }```markdown In Markdown, use the `{: }` wrapper to apply custom classes: -No Line height +No Line height No Line height {: .lh-0 } -Tight line height +Tight line height Tight line height {: .lh-tight } -Default line height +Default line height Default line height {: .fh-default } ``` diff --git a/docs/utilities/utilities.md b/docs/utilities/utilities.md index b368337..a0d2541 100644 --- a/docs/utilities/utilities.md +++ b/docs/utilities/utilities.md @@ -7,7 +7,7 @@ permalink: docs/utilities --- # Utilities -{:.no_toc} +{: .no_toc } CSS utility classes come in handy when you to want to override default styles to give create additional whitespace (margins/padding), unexpected shifts in font-size or weight, add color, or to hide (or show) something a specific screen size. {: .fs-6 .fw-300 } diff --git a/index.md b/index.md index 95ccd65..67635b0 100644 --- a/index.md +++ b/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 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) ### 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.