https://github.com/kjuly/mkdocs-template
MkDocs site template, including automated deployment workflows.
https://github.com/kjuly/mkdocs-template
automation mkdocs template
Last synced: 21 days ago
JSON representation
MkDocs site template, including automated deployment workflows.
- Host: GitHub
- URL: https://github.com/kjuly/mkdocs-template
- Owner: Kjuly
- License: mit
- Created: 2024-05-14T12:19:03.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-07-02T10:23:56.000Z (10 months ago)
- Last Synced: 2025-02-11T09:43:45.245Z (2 months ago)
- Topics: automation, mkdocs, template
- Language: CSS
- Homepage: https://dev.kjuly.com/mkdocs-template/
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-template
MkDocs site template, including automated deployment workflows.
## Structure
Default folder structure in this template:
```sh
.
├─ config/
│ ├─ base.yml # Shared base config file.
│ ├─ en/
│ │ └─ mkdocs.yml # Override config file for "en".
│ └─ zh-Hans/
│ └─ mkdocs.yml # Override config file for "zh-Hans".
│
├─ source/
│ ├─ en/
│ └─ zh-Hans/
│
├─ overrides/
│ ├─ assets/
│ │ └─ logo.png
│ └─ css/
│ └─ extra.css
│
└─ build/
```