diff --git a/README.md b/README.md
index dff46d6..c78280a 100644
--- a/README.md
+++ b/README.md
@@ -4,12 +4,11 @@
A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub pages with few dependencies.
A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.
` element, Just the Docs uses a native system font stack for monospace fonts: +For monospace type, like code snippets or the `` element, Just the Docs uses a native system font stack for monospace fonts: ```scss "SFMono-Regular", Menlo, Consolas, Monospace ``` -ABCDEFGHIJKLMNOPQRSTUVWXYZ +ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz {: .fs-5 .ls-10 .text-mono .code-example } @@ -42,7 +42,7 @@ abcdefghijklmnopqrstuvwxyz ## Responsive type scale -Just the docs uses a responsive type scale that shifts depending on the viewport size. Common elements text elements rendered from markdown use a +Just the Docs uses a responsive type scale that shifts depending on the viewport size. | Selector | Small screen size `font-size` | Large screen size `font-size` | |:----------------------|:---------------------------------|:------------------------------| @@ -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 | --- @@ -109,6 +109,6 @@ Text can be **bold**, _italic_, or ~~strikethrough~~. ## Typographic Utilities -There are a number of specific typographic CSS classes that allow you to do override default styling for font size, font-weight, line height, and capitalization. +There are a number of specific typographic CSS classes that allow you to override default styling for font size, font weight, line height, and capitalization. [View typography utilities]({{ site.baseurl }}{% link docs/utilities/utilities.md %}#typography){: .btn .btn-outline } diff --git a/docs/utilities/color.md b/docs/utilities/color.md index f025f91..ba90b3b 100644 --- a/docs/utilities/color.md +++ b/docs/utilities/color.md @@ -1,12 +1,12 @@ --- layout: default title: Color -nav_order: 3 parent: Utilities +nav_order: 3 --- # Color Utilities -{:.no_toc} +{: .no_toc } ## Table of contents {: .no_toc .text-delta } @@ -16,7 +16,7 @@ parent: Utilities --- -All the colors used in Just the Docs have been systemsized into a series of variables that have been extended to both font color and background color utility classes. +All the colors used in Just the Docs have been systematized into a series of variables that have been extended to both font color and background color utility classes. ## Light Greys diff --git a/docs/utilities/layout.md b/docs/utilities/layout.md index a1b564e..ff248b3 100644 --- a/docs/utilities/layout.md +++ b/docs/utilities/layout.md @@ -1,13 +1,12 @@ --- layout: default title: Layout -nav_order: 2 parent: Utilities -has_children: true +nav_order: 2 --- # Layout Utilities -{:.no_toc} +{: .no_toc } ## Table of contents {: .no_toc .text-delta } @@ -57,15 +56,14 @@ Spacing values are based on a `1rem = 16px` spacing scale, broken down into thes #### Examples {: .no_toc } -```markdown In Markdown, use the `{: }` wrapper to apply custom classes: +```markdown This paragraph will have a margin bottom of 1rem/16px at large screens. {: .mb-lg-4 } This paragraph will have 2rem/32px of padding on the right and left at all screen sizes. {: .px-6 } - ``` ## Vertical Alignment @@ -96,9 +94,9 @@ Use these classes in conjunction with the responsive modifiers. #### Examples {: .no_toc } -```markdown In Markdown, use the `{: }` wrapper to apply custom classes: +```markdown This button will be hidden until medium screen sizes: [ A button ](#url) @@ -111,5 +109,4 @@ These headings will be `inline-block`: ### heading 3 { .d-inline-block } - ``` diff --git a/docs/utilities/responsive-modifiers.md b/docs/utilities/responsive-modifiers.md index 235a1a8..bc5e2cb 100644 --- a/docs/utilities/responsive-modifiers.md +++ b/docs/utilities/responsive-modifiers.md @@ -1,8 +1,8 @@ --- layout: default title: Responsive Modifiers -nav_order: 1 parent: Utilities +nav_order: 1 --- # Responsive modifiers diff --git a/docs/utilities/typography.md b/docs/utilities/typography.md index a517384..786b65a 100644 --- a/docs/utilities/typography.md +++ b/docs/utilities/typography.md @@ -1,12 +1,12 @@ --- layout: default title: Typography -nav_order: 3 parent: Utilities +nav_order: 4 --- # 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..fe4f780 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. +CSS utility classes come in handy when you to want to override default styles to create additional whitespace (margins/padding), correct unexpected shifts in font size or weight, add color, or hide (or show) something at a specific screen size. {: .fs-6 .fw-300 } diff --git a/index.md b/index.md index 95ccd65..aef0e2d 100644 --- a/index.md +++ b/index.md @@ -2,15 +2,14 @@ layout: default title: Home nav_order: 1 -description: "Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub pages." +description: "Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages." permalink: / --- - # 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. +Just the Docs gives your documentation a jumpstart with a responsive Jekyll theme that is easily customizable and hosted on GitHub Pages. {: .fs-6 .fw-300 } [Get started now](#getting-started){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [View it on GitHub](https://github.com/pmarsceill/just-the-docs){: .btn .fs-5 .mb-4 .mb-md-0 } @@ -18,17 +17,21 @@ 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. + +Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generator. View the [quick start guide](https://jekyllrb.com/docs/) 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 ``` -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) +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.