From 5a2a12494c5883531b6c6bfcd8f39c7cbfcde70e Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Fri, 19 Jul 2024 17:33:55 +0400 Subject: Added MkDocs --- docs/index.md | 17 +++++++++++++++++ mkdocs.yml | 26 ++++++++++++++++++++++++++ requirements.txt | 1 + 3 files changed, 44 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/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.yml b/mkdocs.yml new file mode 100644 index 0000000..39f66a3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,26 @@ +# Project information +site_name: WeCLI +site_url: https://wecli.popov.link/ +site_author: Valentin Popov +site_description: >- + Console utilities for SmartTV devices on webOS. + +# Repository +repo_name: valentineus/wecli +repo_url: https://github.com/valentineus/wecli + +# Copyright +copyright: Copyright © 2023 — 2024 Valentin Popov + +# Configuration +theme: + name: material + language: en + palette: + scheme: slate + +# Additional configuration +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/valentineus/wecli diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..4c8f017 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +mkdocs-material -- cgit v1.2.3