init with mkdocs-material, with i18n

This commit is contained in:
songtianlun 2025-09-02 10:39:41 +08:00
commit 5ab2e98784
3 changed files with 58 additions and 0 deletions

17
docs/index.en.md Normal file
View 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.

17
docs/index.md Normal file
View File

@ -0,0 +1,17 @@
# Prmbr
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.

24
mkdocs.yml Normal file
View File

@ -0,0 +1,24 @@
site_name: Prmbr Docs
site_url: https://docs.prmbr.com
theme:
name: material
plugins:
- i18n:
docs_structure: suffix
languages:
- locale: zh
name: Chinese
default: true
build: true
- locale: en
name: English
build: true
# extra:
# alternate:
# - name: Chinese
# link: /zh/
# lang: zh
# - name: English
# link: /en/
# lang: en