This commit is contained in:
parent
4ef6756f59
commit
5a2a12494c
17
docs/index.md
Normal file
17
docs/index.md
Normal file
@ -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.
|
26
mkdocs.yml
Normal file
26
mkdocs.yml
Normal file
@ -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
|
1
requirements.txt
Normal file
1
requirements.txt
Normal file
@ -0,0 +1 @@
|
||||
mkdocs-material
|
Loading…
Reference in New Issue
Block a user