aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/index.md17
-rw-r--r--mkdocs.yml26
-rw-r--r--requirements.txt1
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