Initial MkDocs
This commit is contained in:
parent
78d6eca336
commit
3d48cd3f81
17
docs/index.md
Normal file
17
docs/index.md
Normal file
@ -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.
|
26
mkdocs.yml
Normal file
26
mkdocs.yml
Normal file
@ -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
|
1
requirements.txt
Normal file
1
requirements.txt
Normal file
@ -0,0 +1 @@
|
|||||||
|
mkdocs-material
|
Loading…
Reference in New Issue
Block a user