Skip to content

Commit 45cacc2

Browse files
committed
Documentation
1 parent 5ddeafb commit 45cacc2

File tree

7 files changed

+25
-13
lines changed

7 files changed

+25
-13
lines changed

docs/blog/2021/excluding-content-from-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ directive to the front matter of the respective Markdown file. The good thing
124124
is that the author now only has to check the top of the document to learn
125125
whether it is excluded or not:
126126

127-
``` bash
127+
``` sh
128128
---
129129
search:
130130
exclude: true

docs/customization.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,9 +260,21 @@ very documentation in front of you.
260260

261261
When you're finished making your changes, you can build the theme by invoking:
262262

263+
``` sh
264+
npm run build # (1)!
263265
```
264-
npm run build
265-
```
266+
267+
1. While this command will build all theme files, it will skip the overrides
268+
used in Material for MkDocs' own documentation which are not distributed
269+
with the theme. If you forked the theme and want to build the overrides
270+
as well, use:
271+
272+
```
273+
npm run build:all
274+
```
275+
276+
This will take longer, as now the icon search index, schema files, as
277+
well as additional style sheet and JavaScript files are built.
266278

267279
This triggers the production-level compilation and minification of all style
268280
sheets and JavaScript files. After the command exits, the compiled files are

docs/reference/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ See additional configuration options:
3434
When [Metadata] is enabled, the page title can be overridden for a document with
3535
some custom front matter. Add the following lines at the top of a Markdown file:
3636
37-
``` bash
37+
``` sh
3838
---
3939
title: Lorem ipsum dolor sit amet # (1)!
4040
---
@@ -57,7 +57,7 @@ When [Metadata] is enabled, the page description can be overridden for a
5757
document with custom front matter. Add the following lines at the top of a
5858
Markdown file:
5959

60-
``` bash
60+
``` sh
6161
---
6262
description: Nullam urna elit, malesuada eget finibus ut, ac tortor. # (1)!
6363
---
@@ -79,7 +79,7 @@ An icon can be assigned to each page, which is then rendered as part of the
7979
navigation sidebar. Ensure [Metadata] is enabled and add the following lines
8080
at the top of a Markdown file:
8181

82-
``` bash
82+
``` sh
8383
---
8484
icon: material/emoticon-happy # (1)!
8585
---
@@ -108,7 +108,7 @@ If you're using [theme extension] and created a new page template in the
108108
`overrides` directory, you can enable it for a specific page. Add the following
109109
lines at the top of a Markdown file:
110110

111-
``` bash
111+
``` sh
112112
---
113113
template: custom.html
114114
---

docs/setup/setting-up-navigation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ When [Metadata] is enabled, the navigation and/or table of contents sidebars
302302
can be hidden for a document with custom front matter. Add the following lines
303303
at the top of a Markdown file:
304304

305-
``` bash
305+
``` sh
306306
---
307307
hide:
308308
- navigation

docs/setup/setting-up-site-analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ The following properties must be set for each rating:
236236
When [Metadata] is enabled, the [feedback widget] can be hidden for a document
237237
with custom front matter. Add the following lines at the top of a Markdown file:
238238

239-
``` bash
239+
``` sh
240240
---
241241
hide:
242242
- feedback

docs/setup/setting-up-site-search.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ When [Metadata] is enabled, pages can be boosted in search with custom front
316316
matter, which will make them rank higher. Add the following lines at the top of
317317
a Markdown file:
318318

319-
``` bash
319+
``` sh
320320
---
321321
search:
322322
boost: 2 # (1)!
@@ -341,7 +341,7 @@ When [Metadata] is enabled, pages can be excluded from search with custom front
341341
matter, removing them from the index. Add the following lines at the top of a
342342
Markdown file:
343343

344-
``` bash
344+
``` sh
345345
---
346346
search:
347347
exclude: true

docs/setup/setting-up-tags.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ When both, the [built-in tags plugin] and [Metadata] extension are enabled,
5757
tags can be added for a document with custom front matter. Add the following
5858
lines at the top of a Markdown file:
5959

60-
``` bash
60+
``` sh
6161
---
6262
tags:
6363
- insiders
@@ -113,7 +113,7 @@ While the tags are rendered above the main headline, sometimes, it might be
113113
desirable to hide them for a specific page, which can be achieved by using the
114114
[Metadata] extension:
115115

116-
``` bash
116+
``` sh
117117
---
118118
hide:
119119
- tags

0 commit comments

Comments
 (0)