Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,14 @@ nav = [
{path: "README.md", title: "Introduction"},
{path: "CREDITS.md", title: "Credits"},
]
loaders = [
{package: "mkdocs:theme"},
{directory: "docs"},
]

[loaders]
theme = "pkg://mkdocs/default"
docs = "dir://docs"

[context]
title = "Documentation"
favicon = "📘"
```

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

1. Modify [the HTML templating](styling.md#templates) to customise the layout.
2. Override or add [CSS and JavaScript](styling.md#statics) static assets.

## Compatability

*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.*
4 changes: 0 additions & 4 deletions src/mkdocs/mkdocs.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
import base64
import io
import json
import os
import pathlib
import posixpath
import typing
import zipfile

import httpx
import flask
import jinja2
import markdown
import tomllib
Expand Down