Skip to content

Docs tweak #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lovelydinosaur merged 1 commit into from
Feb 13, 2026
Merged

Docs tweak #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ $ pip install git+https://github.com/encode/mkdocs.git
1. Create additional markdown pages.
2. Use [markdown interlinking](navigation.md#interlinking) between pages.
3. Create a `mkdocs.toml` file to define [the site navigation](navigation.md#navigation) and other configuration.
4. Move your markdown pages into a `docs` directory, and [configure the theme](styling.md#themes).
4. Move your markdown pages into a `docs` directory, and update the config.

An example `mkdocs.toml`...

```toml
[mkdocs]
nav = [
{path: "README.md", title: "Introduction"},
{path: "CREDITS.md", title: "Credits"},
{path="README.md", title="Introduction"},
{path="CREDITS.md", title="Credits"},
]

[loaders]
Expand All @@ -51,5 +51,8 @@ favicon = "📘"

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

1. Modify [the HTML templating](styling.md#templates) to customise the layout.
2. Override or add [CSS and JavaScript](styling.md#statics) static assets.
1. Configure the base theme for your project.
2. Modify [the HTML templating](styling.md#templates) to customise the layout.
3. Override or add [CSS and JavaScript](styling.md#statics) static assets.

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.
13 changes: 8 additions & 5 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ $ pip install git+https://github.com/encode/mkdocs.git
1. Create additional markdown pages.
2. Use [markdown interlinking](navigation.md#interlinking) between pages.
3. Create a `mkdocs.toml` file to define [the site navigation](navigation.md#navigation) and other configuration.
4. Move your markdown pages into a `docs` directory, and [configure the theme](styling.md#themes).
4. Move your markdown pages into a `docs` directory, and update the config.

An example `mkdocs.toml`...

```toml
[mkdocs]
nav = [
{path: "README.md", title: "Introduction"},
{path: "CREDITS.md", title: "Credits"},
{path="README.md", title="Introduction"},
{path="CREDITS.md", title="Credits"},
]

[loaders]
Expand All @@ -51,5 +51,8 @@ favicon = "📘"

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

1. Modify [the HTML templating](styling.md#templates) to customise the layout.
2. Override or add [CSS and JavaScript](styling.md#statics) static assets.
1. Configure the base theme for your project.
2. Modify [the HTML templating](styling.md#templates) to customise the layout.
3. Override or add [CSS and JavaScript](styling.md#statics) static assets.

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.
1 change: 1 addition & 0 deletions src/mkdocs/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
".jpeg": "image/jpeg",
".jpg": "image/jpeg",
".gif": "image/gif",
".svg": "image/svg+xml",
}


Expand Down