Documentation

This commit is contained in:
squidfunk 2022-04-09 23:33:08 +02:00
parent 5ddeafbf4e
commit 45cacc235f
7 changed files with 25 additions and 13 deletions

View File

@ -124,7 +124,7 @@ directive to the front matter of the respective Markdown file. The good thing
is that the author now only has to check the top of the document to learn is that the author now only has to check the top of the document to learn
whether it is excluded or not: whether it is excluded or not:
``` bash ``` sh
--- ---
search: search:
exclude: true exclude: true

View File

@ -260,9 +260,21 @@ very documentation in front of you.
When you're finished making your changes, you can build the theme by invoking: When you're finished making your changes, you can build the theme by invoking:
``` sh
npm run build # (1)!
``` ```
npm run build
``` 1. While this command will build all theme files, it will skip the overrides
used in Material for MkDocs' own documentation which are not distributed
with the theme. If you forked the theme and want to build the overrides
as well, use:
```
npm run build:all
```
This will take longer, as now the icon search index, schema files, as
well as additional style sheet and JavaScript files are built.
This triggers the production-level compilation and minification of all style This triggers the production-level compilation and minification of all style
sheets and JavaScript files. After the command exits, the compiled files are sheets and JavaScript files. After the command exits, the compiled files are

View File

@ -34,7 +34,7 @@ See additional configuration options:
When [Metadata] is enabled, the page title can be overridden for a document with When [Metadata] is enabled, the page title can be overridden for a document with
some custom front matter. Add the following lines at the top of a Markdown file: some custom front matter. Add the following lines at the top of a Markdown file:
``` bash ``` sh
--- ---
title: Lorem ipsum dolor sit amet # (1)! title: Lorem ipsum dolor sit amet # (1)!
--- ---
@ -57,7 +57,7 @@ When [Metadata] is enabled, the page description can be overridden for a
document with custom front matter. Add the following lines at the top of a document with custom front matter. Add the following lines at the top of a
Markdown file: Markdown file:
``` bash ``` sh
--- ---
description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)! description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
--- ---
@ -79,7 +79,7 @@ An icon can be assigned to each page, which is then rendered as part of the
navigation sidebar. Ensure [Metadata] is enabled and add the following lines navigation sidebar. Ensure [Metadata] is enabled and add the following lines
at the top of a Markdown file: at the top of a Markdown file:
``` bash ``` sh
--- ---
icon: material/emoticon-happy # (1)! icon: material/emoticon-happy # (1)!
--- ---
@ -108,7 +108,7 @@ If you're using [theme extension] and created a new page template in the
`overrides` directory, you can enable it for a specific page. Add the following `overrides` directory, you can enable it for a specific page. Add the following
lines at the top of a Markdown file: lines at the top of a Markdown file:
``` bash ``` sh
--- ---
template: custom.html template: custom.html
--- ---

View File

@ -302,7 +302,7 @@ When [Metadata] is enabled, the navigation and/or table of contents sidebars
can be hidden for a document with custom front matter. Add the following lines can be hidden for a document with custom front matter. Add the following lines
at the top of a Markdown file: at the top of a Markdown file:
``` bash ``` sh
--- ---
hide: hide:
- navigation - navigation

View File

@ -236,7 +236,7 @@ The following properties must be set for each rating:
When [Metadata] is enabled, the [feedback widget] can be hidden for a document When [Metadata] is enabled, the [feedback widget] can be hidden for a document
with custom front matter. Add the following lines at the top of a Markdown file: with custom front matter. Add the following lines at the top of a Markdown file:
``` bash ``` sh
--- ---
hide: hide:
- feedback - feedback

View File

@ -316,7 +316,7 @@ When [Metadata] is enabled, pages can be boosted in search with custom front
matter, which will make them rank higher. Add the following lines at the top of matter, which will make them rank higher. Add the following lines at the top of
a Markdown file: a Markdown file:
``` bash ``` sh
--- ---
search: search:
boost: 2 # (1)! boost: 2 # (1)!
@ -341,7 +341,7 @@ When [Metadata] is enabled, pages can be excluded from search with custom front
matter, removing them from the index. Add the following lines at the top of a matter, removing them from the index. Add the following lines at the top of a
Markdown file: Markdown file:
``` bash ``` sh
--- ---
search: search:
exclude: true exclude: true

View File

@ -57,7 +57,7 @@ When both, the [built-in tags plugin] and [Metadata] extension are enabled,
tags can be added for a document with custom front matter. Add the following tags can be added for a document with custom front matter. Add the following
lines at the top of a Markdown file: lines at the top of a Markdown file:
``` bash ``` sh
--- ---
tags: tags:
- insiders - insiders
@ -113,7 +113,7 @@ While the tags are rendered above the main headline, sometimes, it might be
desirable to hide them for a specific page, which can be achieved by using the desirable to hide them for a specific page, which can be achieved by using the
[Metadata] extension: [Metadata] extension:
``` bash ``` sh
--- ---
hide: hide:
- tags - tags