Skip to content

Commit 3ce5050

Browse files
committed
Add mkdocs-material dependency and create new site
1 parent e5690f0 commit 3ce5050

File tree

4 files changed

+274
-0
lines changed

4 files changed

+274
-0
lines changed

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to MkDocs
2+
3+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs -h` - Print help message and exit.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
site_name: My Docs

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ typing = [
2424
changelog = [
2525
"jinja2>=3.1.6"
2626
]
27+
docs = [
28+
"mkdocs-material~=9.6.20"
29+
]
2730

2831
[tool.uv]
2932
required-version = ">=0.7.2"

0 commit comments

Comments
 (0)