From 9e959795be23ba72db87160147f3606a696c6021 Mon Sep 17 00:00:00 2001 From: simon Date: Mon, 20 Mar 2023 10:35:17 +0700 Subject: [PATCH] add basic project structure --- mkdocs/docs/index.md | 17 +++++++++++++++++ mkdocs/mkdocs.yml | 1 + 2 files changed, 18 insertions(+) create mode 100644 mkdocs/docs/index.md create mode 100644 mkdocs/mkdocs.yml diff --git a/mkdocs/docs/index.md b/mkdocs/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/mkdocs/docs/index.md @@ -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. diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml new file mode 100644 index 0000000..37a215c --- /dev/null +++ b/mkdocs/mkdocs.yml @@ -0,0 +1 @@ +site_name: Tube Archivist Documentation