Skip to content

Commit 4715db2

Browse files
Merge pull request #30 from encode/update-readme
Update `README`
2 parents 1e41056 + 313d3e8 commit 4715db2

File tree

2 files changed

+8
-12
lines changed

2 files changed

+8
-12
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,14 @@ nav = [
3535
{path: "README.md", title: "Introduction"},
3636
{path: "CREDITS.md", title: "Credits"},
3737
]
38-
loaders = [
39-
{package: "mkdocs:theme"},
40-
{directory: "docs"},
41-
]
38+
39+
[loaders]
40+
theme = "pkg://mkdocs/default"
41+
docs = "dir://docs"
42+
43+
[context]
44+
title = "Documentation"
45+
favicon = "📘"
4246
```
4347

4448
*Use either [`README.md` or `index.md`](navigation.md#url-structure) for the homepage.*
@@ -49,7 +53,3 @@ Styling adaptations can be kept simple, such as customising the colour scheme, o
4953

5054
1. Modify [the HTML templating](styling.md#templates) to customise the layout.
5155
2. Override or add [CSS and JavaScript](styling.md#statics) static assets.
52-
53-
## Compatability
54-
55-
*Work is planned to handle compatability for both [mkdocs 2.x](https://www.encode.io/mkdocs/) sites, and [mkdocs 1.x](https://www.mkdocs.org/) sites.*

src/mkdocs/mkdocs.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
import base64
21
import io
3-
import json
4-
import os
52
import pathlib
63
import posixpath
74
import typing
85
import zipfile
96

107
import httpx
11-
import flask
128
import jinja2
139
import markdown
1410
import tomllib

0 commit comments

Comments
 (0)