From afd60b6a705cfce7382d9c53da74ae1f8a67f0e7 Mon Sep 17 00:00:00 2001 From: ethfoo Date: Wed, 25 Aug 2021 20:28:03 +0800 Subject: [PATCH] Init --- .github/workflows/ci.yml | 16 ++++ docs/blog/index.md | 0 docs/developer-guide/index.md | 2 + docs/getting-started/index.md | 1 + docs/getting-started/install/kubernetes.md | 0 docs/index.md | 0 docs/reference/index.md | 0 docs/stylesheets/extra.css | 3 + docs/user-guide/index.md | 2 + mkdocs.yml | 85 ++++++++++++++++++++++ nav.yml | 13 ++++ 11 files changed, 122 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 docs/blog/index.md create mode 100644 docs/developer-guide/index.md create mode 100644 docs/getting-started/index.md create mode 100644 docs/getting-started/install/kubernetes.md create mode 100644 docs/index.md create mode 100644 docs/reference/index.md create mode 100644 docs/stylesheets/extra.css create mode 100644 docs/user-guide/index.md create mode 100644 mkdocs.yml create mode 100644 nav.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..c5d2728 --- /dev/null +++ b/.github/workflows/ci.yml @@ -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 diff --git a/docs/blog/index.md b/docs/blog/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/developer-guide/index.md b/docs/developer-guide/index.md new file mode 100644 index 0000000..c752bc0 --- /dev/null +++ b/docs/developer-guide/index.md @@ -0,0 +1,2 @@ +# 开发指南 + diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md new file mode 100644 index 0000000..936b9b6 --- /dev/null +++ b/docs/getting-started/index.md @@ -0,0 +1 @@ +# Why Loggie? \ No newline at end of file diff --git a/docs/getting-started/install/kubernetes.md b/docs/getting-started/install/kubernetes.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 0000000..6e200c7 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,3 @@ +.md-header { + background-color: #5868c1; +} \ No newline at end of file diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md new file mode 100644 index 0000000..79e69be --- /dev/null +++ b/docs/user-guide/index.md @@ -0,0 +1,2 @@ +# 基础架构与核心特性 + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d9f90ce --- /dev/null +++ b/mkdocs.yml @@ -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 diff --git a/nav.yml b/nav.yml new file mode 100644 index 0000000..062e15f --- /dev/null +++ b/nav.yml @@ -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