~skiqqy/wiki.skiqqy.xyz

387aa34fe2f9136cc5b82bfa08ef9252e0d2d0ba — Stephen Cochrane 8 months ago aaaf3d2
Basic setup
3 files changed, 11 insertions(+), 14 deletions(-)

M config
M docs/index.md
M mkdocs.yml
M config => config +1 -0
@@ 1,2 1,3 @@
#!/usr/bin/env bash
wiki=( ) # TODO: Add sub wikis.
pip install mkdocs-windmill-dark # Install the theme being used.

M docs/index.md => docs/index.md +7 -13
@@ 1,17 1,11 @@
# Welcome to MkDocs
# Welcome to the Skiqqy Wiki

For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## About

## Commands
This wiki is built using `mkdocs`, and maintained through
[gwiki](https://git.sr.ht/~skiqqy/gwiki), this is simply the home page of the
wiki, containing links to all sub wikis.

* `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.
## [TODO: Link](/)

## Project layout

    mkdocs.yml    # The configuration file.
    docs/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.
Add small desc for sub wiki when it gets added.

M mkdocs.yml => mkdocs.yml +3 -1
@@ 1,1 1,3 @@
site_name: My Docs
site_name: Skiqqy Wiki
theme:
  name: windmill-dark