From cc46ccf6317dea2ad18791b2cdc36a91b946caaf Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 31 Jan 2021 19:23:28 +0100 Subject: [PATCH] Updated documentation --- docs/creating-your-site.md | 6 +++--- docs/publishing-your-site.md | 4 ++-- docs/setup/setting-up-navigation.md | 22 +++++++++++----------- docs/setup/setting-up-site-search.md | 8 ++++---- docs/setup/setting-up-the-header.md | 4 ++-- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/creating-your-site.md b/docs/creating-your-site.md index eb6a72e38..64b75ca8d 100644 --- a/docs/creating-your-site.md +++ b/docs/creating-your-site.md @@ -41,9 +41,9 @@ This will create the following structure: ### Minimal configuration -To enable the theme, you can now simply add the following lines to `mkdocs.yml`. -Note that since there are several [installation methods][2], configuration will -be slightly different: +Simply add the following lines to `mkdocs.yml` to enable the theme. Note that +since there are several [installation methods][2], configuration might be +slightly different: === "pip, docker" diff --git a/docs/publishing-your-site.md b/docs/publishing-your-site.md index c5681ed12..17f160153 100644 --- a/docs/publishing-your-site.md +++ b/docs/publishing-your-site.md @@ -69,8 +69,8 @@ contents: ``` Now, when a new commit is pushed to either the `master` or `main` branches, -the static site is automatically built and deployed. Commit and push the file -to your repository to see the workflow in action. +the static site is automatically built and deployed. Push your changes to see +the workflow in action. Your documentation should shortly appear at `.github.io/`. diff --git a/docs/setup/setting-up-navigation.md b/docs/setup/setting-up-navigation.md index f288e668d..bf7a0f4d5 100644 --- a/docs/setup/setting-up-navigation.md +++ b/docs/setup/setting-up-navigation.md @@ -21,8 +21,8 @@ and its flag-ship feature: [instant loading][3]. :octicons-unlock-24: Feature flag When _instant loading_ is enabled, clicks on all internal links will be -intercepted and dispatched via [XHR][5] without fully reloading the page. It -can be enabled via `mkdocs.yml` with: +intercepted and dispatched via [XHR][5] without fully reloading the page. Add +the following lines to `mkdocs.yml`: ``` yaml theme: @@ -46,8 +46,8 @@ _Material for MkDocs is the only MkDocs theme offering this feature._ [:octicons-file-code-24: Source][6] · :octicons-unlock-24: Feature flag When _tabs_ are enabled, top-level sections are rendered in a menu layer below -the header for viewports above `1220px`, but remain as-is on mobile.[^1] They -can be enabled via `mkdocs.yml`: +the header for viewports above `1220px`, but remain as-is on mobile.[^1] Add +the following lines to `mkdocs.yml`: [^1]: Prior to version 6.2, navigation tabs had a slightly different behavior. @@ -112,8 +112,8 @@ theme: :octicons-unlock-24: Feature flag When _sections_ are enabled, top-level sections are rendered as groups in the -sidebar for viewports above `1220px`, but remain as-is on mobile. They can also -be enabled via `mkdocs.yml`: +sidebar for viewports above `1220px`, but remain as-is on mobile. Add the +following lines to `mkdocs.yml`: ``` yaml theme: @@ -143,7 +143,7 @@ items. When _expansion_ is enabled, the left sidebar will expand all collapsible subsections by default, so the user doesn't have to open subsections manually. -It can be enabled via `mkdocs.yml` with: +Add the following lines to `mkdocs.yml`: ``` yaml theme: @@ -169,8 +169,8 @@ theme: [:octicons-heart-fill-24:{: .tx-heart } Insiders only][9]{: .tx-insiders } When _section index pages_ are enabled, documents can be directly attached to -sections, which is particularly useful for providing overview pages. This can -be enabled via `mkdocs.yml` with: +sections, which is particularly useful for providing overview pages. Add the +following lines to `mkdocs.yml`: ``` yaml theme: @@ -313,8 +313,8 @@ them at your own risk._ :octicons-unlock-24: Feature flag When _integration_ is enabled, the table of contents is rendered as part of -the navigation for viewports above `1220px`, but remains as-is on mobile. This -can be enabled via `mkdocs.yml`: +the navigation for viewports above `1220px`, but remains as-is on mobile. Add +the following lines to `mkdocs.yml`: ``` yaml theme: diff --git a/docs/setup/setting-up-site-search.md b/docs/setup/setting-up-site-search.md index c121bb521..0d624990a 100644 --- a/docs/setup/setting-up-site-search.md +++ b/docs/setup/setting-up-site-search.md @@ -141,9 +141,9 @@ them at your own risk._ When _search suggestions_ are enabled, the search will display the likeliest completion for the last word, saving the user many key strokes by accepting the -suggestion with ++arrow-right++ +suggestion with the ++arrow-right++ key. -It can be enabled via `mkdocs.yml` with: +Add the following lines to `mkdocs.yml`: ``` yaml theme: @@ -178,7 +178,7 @@ A demo is worth a thousand words — check it out at When _search highlighting_ is enabled and a user clicks on a search result, Material for MkDocs will highlight all occurrences after following the link. -It can be enabled via `mkdocs.yml` with: +Add the following lines to `mkdocs.yml`: ``` yaml theme: @@ -212,7 +212,7 @@ A demo is worth a thousand words — check it out at When _search sharing_ is activated, a :material-share-variant: share button is rendered next to the reset button, which allows to deep link to the current -search query and result. It can be enabled via `mkdocs.yml` with: +search query and result. Add the following lines to `mkdocs.yml`: ``` yaml theme: diff --git a/docs/setup/setting-up-the-header.md b/docs/setup/setting-up-the-header.md index 7451daeee..77bd78dd2 100644 --- a/docs/setup/setting-up-the-header.md +++ b/docs/setup/setting-up-the-header.md @@ -21,8 +21,8 @@ It also includes the [search bar][1] and a place to display your project's :octicons-beaker-24: Experimental When _autohiding_ is enabled, the header is automatically hidden when the -user scrolls past a certain threshold, leaving more space for content. It can -be enabled via `mkdocs.yml` with: +user scrolls past a certain threshold, leaving more space for content. Add the +following lines to `mkdocs.yml`: ``` yaml theme: