Merge pull request #29 from encode/loaders-config

Loaders configuration

Author: lovelydinosaur

docs/configuration.md

@@ -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.*
@@ -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.
-
-## Compatibility
-
-*Work is planned to handle compatibility for both [mkdocs 2.x](https://www.encode.io/mkdocs/) sites, and [mkdocs 1.x](https://www.mkdocs.org/) sites.*

docs/index.md

@@ -121,40 +121,33 @@ Controlling how resources are loaded for the theme and documentation is handled
 *The default theme supplied by the `mkdocs` package, and the documentation served directly from the project directory. This is the default configuration...*
 
 ```toml
-[mkdocs]
-resources = [
-    {package="mkdocs:theme"},
-    {directory="."},
-]
+[loaders]
+theme = "pkg://mkdocs/default"
+docs = "dir://"
 ```
 
 *The default theme as a `.zip` URL, and a local `docs` directory...*
 
 ```toml
-[mkdocs]
-resources = [
-    {url="https://github.com/lovelydinosaur/mkdocs-theme/archive/refs/heads/main.zip"},
-    {directory="docs"},
-]
+[loaders]
+theme = "https://github.com/lovelydinosaur/mkdocs-theme/archive/refs/heads/main.zip"
+docs = "dir://docs"
 ```
 
 *A theme downloaded locally, and a `docs` directory...*
 
 ```toml
-[mkdocs]
-resources = [
-    {directory="theme"},
-    {directory="docs"},
-]
+[loaders]
+theme = "dir://theme"
+docs = "dir://docs"
 ```
 
 *Both the theme and the documentation included in a single directory...*
 
 ```toml
 [mkdocs]
-resources = [
-    {directory="docs"},
-]
+theme = "dir://docs"
+docs = "dir://docs"
 ```
 
 <br/>

docs/styling.md

@@ -5,10 +5,10 @@ nav = [
     {title="Interlinking & Navigation", path="navigation.md"},
     {title="Themes & Styling", path="styling.md"}
 ]
-resources = [
-    {package="mkdocs:theme"},
-    {directory="docs"},
-]
+
+[loaders]
+theme = "pkg://mkdocs/default"
+docs = "dir://docs"
 
 [context]
 title = "MkDocs"