From 78d6bae91cf0ad814a99dfa4f4c4975a9268b4fe Mon Sep 17 00:00:00 2001 From: Pietro Monticone Date: Thu, 16 Feb 2023 16:21:11 +0100 Subject: [PATCH] Fix a few typos --- .vscode/settings.json | 3 +++ docs/alternatives.md | 2 +- docs/browser-support.md | 2 +- docs/changelog/index.md | 6 +++--- docs/insiders/changelog.md | 8 ++++---- docs/insiders/getting-started.md | 2 +- docs/reference/code-blocks.md | 2 +- docs/setup/setting-up-a-blog.md | 2 +- 8 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 36ef96f40..7e278e9a6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -17,5 +17,8 @@ "tag:yaml.org,2002:python/name:materialx.emoji.to_svg", "tag:yaml.org,2002:python/name:materialx.emoji.twemoji", "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" + ], + "cSpell.words": [ + "mkdocs" ] } diff --git a/docs/alternatives.md b/docs/alternatives.md index f3afe6dcb..dcfbda734 100644 --- a/docs/alternatives.md +++ b/docs/alternatives.md @@ -27,7 +27,7 @@ __Challenges__ While [Docusaurus] is one of the best choices when it comes to documentation sites that output a single page application, there are many more solutions, including [Docz], [Gatsby], [Vuepress] and [Docsify] that approach -this problem similarily. +this problem similarly. [Docusaurus]: https://docusaurus.io/ [React]: https://reactjs.org/ diff --git a/docs/browser-support.md b/docs/browser-support.md index e5e3cece8..e24d4fb93 100644 --- a/docs/browser-support.md +++ b/docs/browser-support.md @@ -1,7 +1,7 @@ # Browser support Material for MkDocs goes at great lengths to support the largest possible range -of browsers while retaining the simplemost possibilities for customization via +of browsers while retaining the simplest possibilities for customization via modern CSS features like [custom properties] and [mask images]. [custom properties]: https://caniuse.com/css-variables diff --git a/docs/changelog/index.md b/docs/changelog/index.md index 5b0e270f0..5eb15fc1f 100644 --- a/docs/changelog/index.md +++ b/docs/changelog/index.md @@ -69,7 +69,7 @@ ### 9.0.3 January 8, 2023 { id="9.0.3" } -- Improved discernability of section index pages in navigation +- Improved discernibility of section index pages in navigation - Improved collapsing of adjacent whitespace in search plugin - Updated Indonesian translations - Fixed view source of this page button when edit URL points to blob @@ -229,7 +229,7 @@ __Fixes__ - Added support for cookie consent - Added support for feedback widget (Was this page helpful?) -- Added support for dismissable announcement bar +- Added support for dismissible announcement bar - Added Armenian, Lithuanian, Tagalog, and Urdu translations ### 8.3.9 July 4, 2022 { id="8.3.9" } @@ -369,7 +369,7 @@ __Fixes__ ### 8.2.2 February 26, 2022 { id="8.2.2" } - Added automatic removal of query parameter when search is closed -- Fixed #3599: Anchors always overriden when using navigation tracking +- Fixed #3599: Anchors always overridden when using navigation tracking ### 8.2.1 February 17, 2022 { id="8.2.1" } diff --git a/docs/insiders/changelog.md b/docs/insiders/changelog.md index 9c711e06a..f1147e5a1 100644 --- a/docs/insiders/changelog.md +++ b/docs/insiders/changelog.md @@ -262,7 +262,7 @@ ### 4.15.1 May 14, 2022 { id="4.15.1" } -- Improved performance of element focus obervables +- Improved performance of element focus observables - Fixed #3531: Added prev/next buttons to content tabs - Fixed tooltip positioning when host element is hidden @@ -385,7 +385,7 @@ ### 4.2.0 December 2, 2021 { id="4.2.0" } -- Added support for dismissable announcement bar +- Added support for dismissible announcement bar - Added support for named placeholders in feedback widget ### 4.1.0 November 30, 2021 { id="4.1.0" } @@ -400,7 +400,7 @@ - Removed deprecated prebuilt search index support - Removed deprecated web app manifest – use customization - Removed `extracopyright` variable – use new `copyright` partial -- Removed Disqus integation – use customization +- Removed Disqus integration – use customization - Switched to `:is()` selectors for simple selector lists - Switched autoprefixer from `last 4 years` to `last 2 years` - Improved CSS overall to match modern standards @@ -519,7 +519,7 @@ ### 2.11.0 July 18, 2021 { id="2.11.0" } -- Improved Mermaid.js intergration, now stable +- Improved Mermaid.js integration, now stable - Added support for sequence diagrams - Added support for entity relationship diagrams - Added support for cookie consent configuration diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index 8b8157dfe..cb0368bc0 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -5,7 +5,7 @@ title: Getting started with Insiders # Getting started with Insiders Material for MkDocs Insiders is a compatible drop-in replacement for Material -for MkDocs, and can be installed similarily using [`pip`][pip], +for MkDocs, and can be installed similarly using [`pip`][pip], [`docker`][docker] or [`git`][git]. Note that in order to access the Insiders repository, you need to [become an eligible sponsor] of @squidfunk on GitHub. diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md index 8dd034080..a8db1b723 100644 --- a/docs/reference/code-blocks.md +++ b/docs/reference/code-blocks.md @@ -72,7 +72,7 @@ theme: ```` Note that the language shortcode which has to come first must now also be - prefixed by a `.`. Similarily, the copy button can also be disabled for a + prefixed by a `.`. Similarly, the copy button can also be disabled for a specific code block: ```` { .yaml .no-copy } diff --git a/docs/setup/setting-up-a-blog.md b/docs/setup/setting-up-a-blog.md index ff869fca9..76976a9ce 100644 --- a/docs/setup/setting-up-a-blog.md +++ b/docs/setup/setting-up-a-blog.md @@ -1143,7 +1143,7 @@ links: ``` If you look closely, you'll realize that you can even use an anchor to link to -a specific section of a document, extending the possiblities of the [`nav`][nav] +a specific section of a document, extending the possibilities of the [`nav`][nav] syntax in `mkdocs.yml`. The [built-in blog plugin] resolves the anchor and sets the title of the anchor as a [subtitle] of the related link.