Add initial test of site using markdown and makedoc

This commit is contained in:
Chris 2025-01-11 22:36:53 +00:00
commit e7e9948c70
4 changed files with 49 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*~
.cache/
site/

13
docs/about.md Normal file
View File

@ -0,0 +1,13 @@
# About
I am Chris (although you may know me as my alter-ego, Jeremiah Fieldhaven).
I've been developing software since the 1980s, and at this point it's not
so much something I do as something I am. As my day job has drifted inexorably
along the path to Management, I've found I really need to make time to just
write code and build things in my spare time to save my sanity.
I'm currently using Unreal Engine 5 to build a 3D puzzle game called Project
Shinar, a game inspired by an old Amiga game called Tower of Babel with
visuals reminiscent of the neon-glowing polygons of TRON.
I'm generally terrible at keeping websites updated!

17
docs/index.md Normal file
View 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.

16
mkdocs.yml Normal file
View File

@ -0,0 +1,16 @@
site_name: Starforge
site_url: https://www.starforge.co.uk/site
nav:
- Home: index.md
- About: about.md
theme:
font:
text: Roboto
code: Roboto Mono
name: material
palette:
scheme: slate
features:
- navigation.tabs
plugins:
- privacy