diff --git a/assets/css/dark-mode-preview.scss b/assets/css/dark-mode-preview.scss index f30f9e0..8b77da6 100644 --- a/assets/css/dark-mode-preview.scss +++ b/assets/css/dark-mode-preview.scss @@ -10,7 +10,7 @@ @import "./vendor/normalize.scss/normalize.scss"; // -// Import Just the docs scss +// Import Just the Docs scss // // Support diff --git a/assets/css/just-the-docs.scss b/assets/css/just-the-docs.scss index 601cdaa..3431ae8 100644 --- a/assets/css/just-the-docs.scss +++ b/assets/css/just-the-docs.scss @@ -10,7 +10,7 @@ @import "./vendor/normalize.scss/normalize.scss"; // -// Import Just the docs scss +// Import Just the Docs scss // // Support diff --git a/docs/customization.md b/docs/customization.md index 8c019e0..0ed6c2e 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -51,9 +51,9 @@ addEvent(toggleDarkMode, 'click', function(){ ## Specific visual customization -To customize your site’s aesthetic, open `_sass/custom/custom.scss` in your editor to see if there is a variable that you can override. Most styles like fonts, colors, spacing, etc.. are derived from these variables. To override a specific variable, uncomment out it’s line and change it’s value. +To customize your site’s aesthetic, open `_sass/custom/custom.scss` in your editor to see if there is a variable that you can override. Most styles like fonts, colors, spacing, etc. are derived from these variables. To override a specific variable, uncomment its line and change its value. -For example, to change the link color from the purple default to blue, open `_sass/custom/custom.css` and find the `$link-color` variable on line `50`. Uncomment it out, and change it's value to our `$blue-000` variable, or another shade of your choosing. +For example, to change the link color from the purple default to blue, open `_sass/custom/custom.css` and find the `$link-color` variable on line `50`. Uncomment it, and change its value to our `$blue-000` variable, or another shade of your choosing. #### Example {: no_toc } diff --git a/docs/navigation-structure.md b/docs/navigation-structure.md index d85c7f0..8a72e5b 100644 --- a/docs/navigation-structure.md +++ b/docs/navigation-structure.md @@ -25,7 +25,7 @@ By default, all pages will appear as top level pages in the main nav unless a pa ## Ordering pages -To specify a page order, use the `nav_order` variable in your pages' YAML front matter. +To specify a page order, use the `nav_order` parameter in your pages' YAML front matter. #### Example {: .no_toc } @@ -42,7 +42,7 @@ nav_order: 4 ## Excluding pages -For specific pages that you do not wish to include in the main navigation, e.g. a 404 page or a landing page. Use the `nav_exclude: true` parameter in the YAML front matter for that page. +For specific pages that you do not wish to include in the main navigation, e.g. a 404 page or a landing page, use the `nav_exclude: true` parameter in the YAML front matter for that page. #### Example {: .no_toc } @@ -59,7 +59,7 @@ nav_exclude: true ## Pages with children -Sometimes you will want to create a page with many children (a section). First, it is recommended that you keep pages that are related in a directory together... For example, in these docs, we keep all of the written documentation in the `./docs` directory and each of the sections in subdirectories like `./docs/ui-components` and `./docs/utilities`. This gives is an organization like: +Sometimes you will want to create a page with many children (a section). First, it is recommended that you keep pages that are related in a directory together... For example, in these docs, we keep all of the written documentation in the `./docs` directory and each of the sections in subdirectories like `./docs/ui-components` and `./docs/utilities`. This gives us an organization like: ``` +-- .. @@ -88,9 +88,9 @@ Sometimes you will want to create a page with many children (a section). First, +-- .. ``` -On the parent pages, add 2 YAML front matter variables: -- `has_children: true` (tells us that this a parent page) -- `permalink:` set this to the site directories that the contains the pages +On the parent pages, add 2 YAML front matter parameters: +- `has_children: true` (tells us that this is a parent page) +- `permalink:` set this to the site directory that contains the child pages #### Example {: .no_toc } @@ -105,7 +105,7 @@ permalink: /docs/ui-components --- ``` -Here we're setting up the UI Components landing page that is available at `/docs/ui-components`, it has children and is ordered second in the main nav. +Here we're setting up the UI Components landing page that is available at `/docs/ui-components`, which has children and is ordered second in the main nav. ### Child pages {: .text-gamma } @@ -124,9 +124,11 @@ nav_order: 2 --- ``` +The Buttons page appears as a child of UI Components and appears second in the UI Components section. + ### Auto-generating Table of Contents -By default, all pages with children will automatically append a Table of Contents which lists the child pages after the parent page's content. To disable this auto Table of Contents, set `has_toc: false` on the parent page's YAML front matter. +By default, all pages with children will automatically append a Table of Contents which lists the child pages after the parent page's content. To disable this auto Table of Contents, set `has_toc: false` in the parent page's YAML front matter. #### Example {: .no_toc } @@ -142,8 +144,6 @@ permalink: /docs/ui-components --- ``` -The Buttons page appears a child of UI Components and appears second in the UI Components section. - ### Children with children {: .text-gamma } @@ -175,7 +175,7 @@ nav_order: 1 --- ``` -Would create the following navigation structure: +This would create the following navigation structure: ``` +-- .. @@ -211,7 +211,7 @@ aux_links: ## In-page navigation with Table of Contents -To generate a Table of Contents on your docs pages, you can use the `{:toc}` method from Kramdown, immediately after an `
` 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 @@ -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` | |:----------------------|:---------------------------------|:------------------------------| @@ -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 79b3529..7b2aa65 100644 --- a/docs/utilities/color.md +++ b/docs/utilities/color.md @@ -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 ac03f7e..92d1234 100644 --- a/docs/utilities/layout.md +++ b/docs/utilities/layout.md @@ -57,9 +57,9 @@ 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 } @@ -95,9 +95,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) diff --git a/docs/utilities/utilities.md b/docs/utilities/utilities.md index a0d2541..fe4f780 100644 --- a/docs/utilities/utilities.md +++ b/docs/utilities/utilities.md @@ -9,5 +9,5 @@ permalink: docs/utilities # Utilities {: .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 67635b0..1576d6e 100644 --- a/index.md +++ b/index.md @@ -2,14 +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 } @@ -19,8 +19,8 @@ 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/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 @@ -28,7 +28,7 @@ Just the Docs is built for [Jekyll](https://jekyllrb.com), a static site generat ```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