Skip to content

Commit

Permalink
refs #147: Stubbed mkDocs-based documentation directory and docker-co…
Browse files Browse the repository at this point in the history
…mpose file for local inspection.
  • Loading branch information
stickgrinder committed Jan 5, 2024
1 parent 71c3cf7 commit 779580f
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: "3"
services:
mkdocs:
volumes:
- ./docs:/app
working_dir: /app
labels:
- com.dnsdock.alias=docs.popochiu.loc
image: minidocks/mkdocs
command: serve -a 0.0.0.0:80 -t readthedocs
17 changes: 17 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 2 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
site_name: Popochiu
theme: readthedocs

0 comments on commit 779580f

Please sign in to comment.