~skiqqy/wiki.skiqqy.xyz

aaaf3d25ff68c28aa82a2963ab38b8c23f09804a — Stephen Cochrane 8 months ago
Init
5 files changed, 33 insertions(+), 0 deletions(-)

A .gitignore
A README.md
A config
A docs/index.md
A mkdocs.yml
A  => .gitignore +2 -0
@@ 1,2 @@
*.swp
site/

A  => README.md +11 -0
@@ 1,11 @@
# The skiqqy Wiki

This is the root wiki of [wiki.skiqqy.xyz](https://wiki.skiqqy.xyz/site).
This wiki is built using mkdocs, and hosted/ curated using [gwiki](https://git.sr.ht/~skiqqy/gwiki).

## Building

> Simply invoke
```
$ mkdocs build
```

A  => config +2 -0
@@ 1,2 @@
#!/usr/bin/env bash
wiki=( ) # TODO: Add sub wikis.

A  => docs/index.md +17 -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.

A  => mkdocs.yml +1 -0
@@ 1,1 @@
site_name: My Docs