Skip to content

Commit 2725a8c

Browse files
Docs tweak
1 parent 4715db2 commit 2725a8c

File tree

3 files changed

+17
-10
lines changed

3 files changed

+17
-10
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ $ pip install git+https://github.com/encode/mkdocs.git
2525
1. Create additional markdown pages.
2626
2. Use [markdown interlinking](navigation.md#interlinking) between pages.
2727
3. Create a `mkdocs.toml` file to define [the site navigation](navigation.md#navigation) and other configuration.
28-
4. Move your markdown pages into a `docs` directory, and [configure the theme](styling.md#themes).
28+
4. Move your markdown pages into a `docs` directory, and update the config.
2929

3030
An example `mkdocs.toml`...
3131

3232
```toml
3333
[mkdocs]
3434
nav = [
35-
{path: "README.md", title: "Introduction"},
36-
{path: "CREDITS.md", title: "Credits"},
35+
{path="README.md", title="Introduction"},
36+
{path="CREDITS.md", title="Credits"},
3737
]
3838

3939
[loaders]
@@ -51,5 +51,8 @@ favicon = "📘"
5151

5252
Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.
5353

54-
1. Modify [the HTML templating](styling.md#templates) to customise the layout.
55-
2. Override or add [CSS and JavaScript](styling.md#statics) static assets.
54+
1. Configure the base theme for your project.
55+
2. Modify [the HTML templating](styling.md#templates) to customise the layout.
56+
3. Override or add [CSS and JavaScript](styling.md#statics) static assets.
57+
58+
Take a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming.

docs/index.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ $ pip install git+https://github.com/encode/mkdocs.git
2525
1. Create additional markdown pages.
2626
2. Use [markdown interlinking](navigation.md#interlinking) between pages.
2727
3. Create a `mkdocs.toml` file to define [the site navigation](navigation.md#navigation) and other configuration.
28-
4. Move your markdown pages into a `docs` directory, and [configure the theme](styling.md#themes).
28+
4. Move your markdown pages into a `docs` directory, and update the config.
2929

3030
An example `mkdocs.toml`...
3131

3232
```toml
3333
[mkdocs]
3434
nav = [
35-
{path: "README.md", title: "Introduction"},
36-
{path: "CREDITS.md", title: "Credits"},
35+
{path="README.md", title="Introduction"},
36+
{path="CREDITS.md", title="Credits"},
3737
]
3838

3939
[loaders]
@@ -51,5 +51,8 @@ favicon = "📘"
5151

5252
Styling adaptations can be kept simple, such as customising the colour scheme, or more comprehensive, such as creating an entirely new theme.
5353

54-
1. Modify [the HTML templating](styling.md#templates) to customise the layout.
55-
2. Override or add [CSS and JavaScript](styling.md#statics) static assets.
54+
1. Configure the base theme for your project.
55+
2. Modify [the HTML templating](styling.md#templates) to customise the layout.
56+
3. Override or add [CSS and JavaScript](styling.md#statics) static assets.
57+
58+
Take a look at the [default theme](https://github.com/lovelydinosaur/mkdocs-theme) and the [kelp theme](https://github.com/lovelydinosaur/kelp-theme) for examples of getting started with theming.

src/mkdocs/cli.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
".jpeg": "image/jpeg",
1515
".jpg": "image/jpeg",
1616
".gif": "image/gif",
17+
".svg": "image/svg+xml",
1718
}
1819

1920

0 commit comments

Comments
 (0)