This commit is contained in:
ethfoo 2021-08-25 20:28:03 +08:00
commit afd60b6a70
11 changed files with 122 additions and 0 deletions

16
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,16 @@
name: ci
on:
push:
branches:
- master
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force

0
docs/blog/index.md Normal file
View File

View File

@ -0,0 +1,2 @@
# 开发指南

View File

@ -0,0 +1 @@
# Why Loggie?

0
docs/index.md Normal file
View File

0
docs/reference/index.md Normal file
View File

View File

@ -0,0 +1,3 @@
.md-header {
background-color: #5868c1;
}

2
docs/user-guide/index.md Normal file
View File

@ -0,0 +1,2 @@
# 基础架构与核心特性

85
mkdocs.yml Normal file
View File

@ -0,0 +1,85 @@
INHERIT: nav.yml
site_name: Loggie
site_description: Loggie Documentation
extra_css:
- stylesheets/extra.css
theme:
name: material
language: zh
features:
- content.code.annotate
- content.tabs.link
- header.autohide
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.integrate
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
markdown_extensions:
- admonition
- abbr
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid-experimental
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
copyright: Copyright © 2021 Loggie.io
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/loggie-io

13
nav.yml Normal file
View File

@ -0,0 +1,13 @@
nav:
- Home: index.md
- Getting Started:
- Overview: getting-started/index.md
- Installation:
- Kubernetes: getting-started/install/kubernetes.md
- User Guide:
- Overview: user-guide/index.md
- Developer Guide:
- Overview: developer-guide/index.md
- Reference:
- Overview: reference/index.md
- Blog: blog/index.md