Chris/Website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Replace default mkdocs index.md with something approaching a proper page

Browse Source
This commit is contained in:
Chris 2025-01-18 23:04:38 +00:00
parent 86eb85a23b
commit 4ef34987c2
1 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/index.md
View File

@ -1,17 +1,15 @@
# Welcome to MkDocs # Welcome
For full documentation visit [mkdocs.org](https://www.mkdocs.org). After having my old site sit dormant for the best part of five years, I think it's probably
finally time to try something a bit different. For a start, I've ditched Wordpress; in part
because of the unending tantrums of Matt "Drama" Mullenweg, but mainly because Wordpress is
just overkill for what I need (as well as being constantly attacked.)
## Commands This new site is based on [MkDocs](https://www.mkdocs.org/) and [MKDocs Material](https://squidfunk.github.io/mkdocs-material/)
and automatically builds when I push the git repository containing the source files. I'll
be describing the setup for that soon, as well as talking about my current work in progress
game [Project Shinar](https://jeremiahfieldhaven.itch.io/project-shinar).
* `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 ## Latest updates
2025-01-19: New site
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.