diff options
| author | Valentin Popov <valentin@popov.link> | 2024-02-06 01:26:50 +0300 |
|---|---|---|
| committer | Valentin Popov <valentin@popov.link> | 2024-02-06 01:26:50 +0300 |
| commit | 3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd (patch) | |
| tree | 5904e98f11a5733901aa39751a17425bb5281eb8 | |
| parent | 78d6eca33641515993213ed912fd22a019be7f14 (diff) | |
| download | fparkan-3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd.tar.xz fparkan-3d48cd3f81164bbfc1a755dc1d4a9a02f98c8ddd.zip | |
| -rw-r--r-- | docs/index.md | 17 | ||||
| -rw-r--r-- | mkdocs.yml | 26 | ||||
| -rw-r--r-- | requirements.txt | 1 |
3 files changed, 44 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..fc95499 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,26 @@ +# Project information +site_name: FParkan +site_url: https://fparkan.popov.link/ +site_author: Valentin Popov +site_description: >- + Utilities and tools for the game “Parkan: Iron Strategy”. + +# Repository +repo_name: valentineus/fparkan +repo_url: https://github.com/valentineus/fparkan + +# Copyright +copyright: Copyright © 2023 — 2024 Valentin Popov + +# Configuration +theme: + name: material + language: en + palette: + scheme: slate + +# Additional configuration +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/valentineus/fparkan diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..4c8f017 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material |