Cool_Tools/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-11-24 07:30:12 +01:00
Code Issues Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
squidfunk 2021-01-31 19:23:28 +01:00
parent accc2a34d1
commit cc46ccf631
5 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/creating-your-site.md
View File

@ -41,9 +41,9 @@ This will create the following structure:
### Minimal configuration ### Minimal configuration
To enable the theme, you can now simply add the following lines to `mkdocs.yml`. Simply add the following lines to `mkdocs.yml` to enable the theme. Note that
Note that since there are several [installation methods][2], configuration will since there are several [installation methods][2], configuration might be
be slightly different: slightly different:
=== "pip, docker" === "pip, docker"

4
docs/publishing-your-site.md
View File

@ -69,8 +69,8 @@ contents:
``` ```
Now, when a new commit is pushed to either the `master` or `main` branches, 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 the static site is automatically built and deployed. Push your changes to see
to your repository to see the workflow in action. the workflow in action.
Your documentation should shortly appear at `<username>.github.io/<repository>`. Your documentation should shortly appear at `<username>.github.io/<repository>`.

22
docs/setup/setting-up-navigation.md
View File

@ -21,8 +21,8 @@ and its flag-ship feature: [instant loading][3].
:octicons-unlock-24: Feature flag :octicons-unlock-24: Feature flag
When _instant loading_ is enabled, clicks on all internal links will be When _instant loading_ is enabled, clicks on all internal links will be
intercepted and dispatched via [XHR][5] without fully reloading the page. It intercepted and dispatched via [XHR][5] without fully reloading the page. Add
can be enabled via `mkdocs.yml` with: the following lines to `mkdocs.yml`:
``` yaml ``` yaml
theme: 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 [: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 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 the header for viewports above `1220px`, but remain as-is on mobile.[^1] Add
can be enabled via `mkdocs.yml`: the following lines to `mkdocs.yml`:
[^1]: [^1]:
Prior to version 6.2, navigation tabs had a slightly different behavior. Prior to version 6.2, navigation tabs had a slightly different behavior.
@ -112,8 +112,8 @@ theme:
:octicons-unlock-24: Feature flag :octicons-unlock-24: Feature flag
When _sections_ are enabled, top-level sections are rendered as groups in the 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 sidebar for viewports above `1220px`, but remain as-is on mobile. Add the
be enabled via `mkdocs.yml`: following lines to `mkdocs.yml`:
``` yaml ``` yaml
theme: theme:
@ -143,7 +143,7 @@ items.
When _expansion_ is enabled, the left sidebar will expand all collapsible When _expansion_ is enabled, the left sidebar will expand all collapsible
subsections by default, so the user doesn't have to open subsections manually. 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 ``` yaml
theme: theme:
@ -169,8 +169,8 @@ theme:
[:octicons-heart-fill-24:{: .tx-heart } Insiders only][9]{: .tx-insiders } [:octicons-heart-fill-24:{: .tx-heart } Insiders only][9]{: .tx-insiders }
When _section index pages_ are enabled, documents can be directly attached to When _section index pages_ are enabled, documents can be directly attached to
sections, which is particularly useful for providing overview pages. This can sections, which is particularly useful for providing overview pages. Add the
be enabled via `mkdocs.yml` with: following lines to `mkdocs.yml`:
``` yaml ``` yaml
theme: theme:
@ -313,8 +313,8 @@ them at your own risk._
:octicons-unlock-24: Feature flag :octicons-unlock-24: Feature flag
When _integration_ is enabled, the table of contents is rendered as part of 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 the navigation for viewports above `1220px`, but remains as-is on mobile. Add
can be enabled via `mkdocs.yml`: the following lines to `mkdocs.yml`:
``` yaml ``` yaml
theme: theme:

8
docs/setup/setting-up-site-search.md
View File

@ -141,9 +141,9 @@ them at your own risk._
When _search suggestions_ are enabled, the search will display the likeliest 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 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 ``` yaml
theme: 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, When _search highlighting_ is enabled and a user clicks on a search result,
Material for MkDocs will highlight all occurrences after following the link. 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 ``` yaml
theme: 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 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 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 ``` yaml
theme: theme:

4
docs/setup/setting-up-the-header.md
View File

@ -21,8 +21,8 @@ It also includes the [search bar][1] and a place to display your project's
:octicons-beaker-24: Experimental :octicons-beaker-24: Experimental
When _autohiding_ is enabled, the header is automatically hidden when the When _autohiding_ is enabled, the header is automatically hidden when the
user scrolls past a certain threshold, leaving more space for content. It can user scrolls past a certain threshold, leaving more space for content. Add the
be enabled via `mkdocs.yml` with: following lines to `mkdocs.yml`:
``` yaml ``` yaml
theme: theme: