From 4038d56abfe3b08f709faa504bc640dfa160c04e Mon Sep 17 00:00:00 2001 From: Savorboard Date: Fri, 1 Mar 2019 21:16:09 +0800 Subject: [PATCH] Documentation Revamp --- docs/{ => content}/about/contact-us.md | 0 docs/{ => content}/about/contributing.md | 0 docs/{ => content}/about/license.md | 0 docs/{ => content}/about/release-notes.md | 0 docs/{ => content}/img/architecture.png | Bin docs/{ => content}/img/rabbitmq-route.png | Bin docs/{ => content}/index.md | 0 .../user-guide-cn/api-interface.md | 0 .../user-guide-cn/configuration.md | 0 .../user-guide-cn/design-principle.md | 0 .../user-guide-cn/distributed-transactions.md | 0 docs/{ => content}/user-guide-cn/faq.md | 0 .../user-guide-cn/getting-started.md | 0 .../implementation-mechanisms.md | 0 .../{ => content}/user-guide/api-interface.md | 0 .../{ => content}/user-guide/configuration.md | 0 docs/{ => content}/user-guide/design.md | 0 docs/{ => content}/user-guide/faq.md | 0 .../user-guide/getting-started.md | 0 .../user-guide/implementation.md | 0 docs/{ => content}/user-guide/transaction.md | 0 mkdocs.yml => docs/mkdocs.yml | 67 ++++++++++-------- 22 files changed, 36 insertions(+), 31 deletions(-) rename docs/{ => content}/about/contact-us.md (100%) rename docs/{ => content}/about/contributing.md (100%) rename docs/{ => content}/about/license.md (100%) rename docs/{ => content}/about/release-notes.md (100%) rename docs/{ => content}/img/architecture.png (100%) rename docs/{ => content}/img/rabbitmq-route.png (100%) rename docs/{ => content}/index.md (100%) rename docs/{ => content}/user-guide-cn/api-interface.md (100%) rename docs/{ => content}/user-guide-cn/configuration.md (100%) rename docs/{ => content}/user-guide-cn/design-principle.md (100%) rename docs/{ => content}/user-guide-cn/distributed-transactions.md (100%) rename docs/{ => content}/user-guide-cn/faq.md (100%) rename docs/{ => content}/user-guide-cn/getting-started.md (100%) rename docs/{ => content}/user-guide-cn/implementation-mechanisms.md (100%) rename docs/{ => content}/user-guide/api-interface.md (100%) rename docs/{ => content}/user-guide/configuration.md (100%) rename docs/{ => content}/user-guide/design.md (100%) rename docs/{ => content}/user-guide/faq.md (100%) rename docs/{ => content}/user-guide/getting-started.md (100%) rename docs/{ => content}/user-guide/implementation.md (100%) rename docs/{ => content}/user-guide/transaction.md (100%) rename mkdocs.yml => docs/mkdocs.yml (91%) diff --git a/docs/about/contact-us.md b/docs/content/about/contact-us.md similarity index 100% rename from docs/about/contact-us.md rename to docs/content/about/contact-us.md diff --git a/docs/about/contributing.md b/docs/content/about/contributing.md similarity index 100% rename from docs/about/contributing.md rename to docs/content/about/contributing.md diff --git a/docs/about/license.md b/docs/content/about/license.md similarity index 100% rename from docs/about/license.md rename to docs/content/about/license.md diff --git a/docs/about/release-notes.md b/docs/content/about/release-notes.md similarity index 100% rename from docs/about/release-notes.md rename to docs/content/about/release-notes.md diff --git a/docs/img/architecture.png b/docs/content/img/architecture.png similarity index 100% rename from docs/img/architecture.png rename to docs/content/img/architecture.png diff --git a/docs/img/rabbitmq-route.png b/docs/content/img/rabbitmq-route.png similarity index 100% rename from docs/img/rabbitmq-route.png rename to docs/content/img/rabbitmq-route.png diff --git a/docs/index.md b/docs/content/index.md similarity index 100% rename from docs/index.md rename to docs/content/index.md diff --git a/docs/user-guide-cn/api-interface.md b/docs/content/user-guide-cn/api-interface.md similarity index 100% rename from docs/user-guide-cn/api-interface.md rename to docs/content/user-guide-cn/api-interface.md diff --git a/docs/user-guide-cn/configuration.md b/docs/content/user-guide-cn/configuration.md similarity index 100% rename from docs/user-guide-cn/configuration.md rename to docs/content/user-guide-cn/configuration.md diff --git a/docs/user-guide-cn/design-principle.md b/docs/content/user-guide-cn/design-principle.md similarity index 100% rename from docs/user-guide-cn/design-principle.md rename to docs/content/user-guide-cn/design-principle.md diff --git a/docs/user-guide-cn/distributed-transactions.md b/docs/content/user-guide-cn/distributed-transactions.md similarity index 100% rename from docs/user-guide-cn/distributed-transactions.md rename to docs/content/user-guide-cn/distributed-transactions.md diff --git a/docs/user-guide-cn/faq.md b/docs/content/user-guide-cn/faq.md similarity index 100% rename from docs/user-guide-cn/faq.md rename to docs/content/user-guide-cn/faq.md diff --git a/docs/user-guide-cn/getting-started.md b/docs/content/user-guide-cn/getting-started.md similarity index 100% rename from docs/user-guide-cn/getting-started.md rename to docs/content/user-guide-cn/getting-started.md diff --git a/docs/user-guide-cn/implementation-mechanisms.md b/docs/content/user-guide-cn/implementation-mechanisms.md similarity index 100% rename from docs/user-guide-cn/implementation-mechanisms.md rename to docs/content/user-guide-cn/implementation-mechanisms.md diff --git a/docs/user-guide/api-interface.md b/docs/content/user-guide/api-interface.md similarity index 100% rename from docs/user-guide/api-interface.md rename to docs/content/user-guide/api-interface.md diff --git a/docs/user-guide/configuration.md b/docs/content/user-guide/configuration.md similarity index 100% rename from docs/user-guide/configuration.md rename to docs/content/user-guide/configuration.md diff --git a/docs/user-guide/design.md b/docs/content/user-guide/design.md similarity index 100% rename from docs/user-guide/design.md rename to docs/content/user-guide/design.md diff --git a/docs/user-guide/faq.md b/docs/content/user-guide/faq.md similarity index 100% rename from docs/user-guide/faq.md rename to docs/content/user-guide/faq.md diff --git a/docs/user-guide/getting-started.md b/docs/content/user-guide/getting-started.md similarity index 100% rename from docs/user-guide/getting-started.md rename to docs/content/user-guide/getting-started.md diff --git a/docs/user-guide/implementation.md b/docs/content/user-guide/implementation.md similarity index 100% rename from docs/user-guide/implementation.md rename to docs/content/user-guide/implementation.md diff --git a/docs/user-guide/transaction.md b/docs/content/user-guide/transaction.md similarity index 100% rename from docs/user-guide/transaction.md rename to docs/content/user-guide/transaction.md diff --git a/mkdocs.yml b/docs/mkdocs.yml similarity index 91% rename from mkdocs.yml rename to docs/mkdocs.yml index a9cddb5..47cacd8 100644 --- a/mkdocs.yml +++ b/docs/mkdocs.yml @@ -3,35 +3,16 @@ site_name: CAP site_url: https://cap.dotnet-china.com site_description: Project documentation with Markdown. site_author: CAP Team -repo_name: 'dotnetcore/CAP' -repo_url: 'https://github.com/dotnetcore/cap/' + +repo_name: 'GitHub' +repo_url: 'https://github.com/dotnetcore/cap' + +docs_dir: 'content' # Copyright copyright: Copyright © 2017 .NET Core Community, Maintained by the CAP Team. -nav: - - Home: index.md - - User Guide: - - Getting Started: user-guide/getting-started.md - - API Interface: user-guide/api-interface.md - - Configuration: user-guide/configuration.md - - Design Principle: user-guide/design.md - - Implementation Mechanisms: user-guide/implementation.md - - Distributed Transactions: user-guide/transaction.md - - FAQ: user-guide/faq.md - - 使用指南: - - 快速开始: user-guide-cn/getting-started.md - - API 接口: user-guide-cn/api-interface.md - - 配置: user-guide-cn/configuration.md - - 设计原理: user-guide-cn/design-principle.md - - 实现: user-guide-cn/implementation-mechanisms.md - - 分布式事务: user-guide-cn/distributed-transactions.md - - FAQ: user-guide-cn/faq.md - - About: - - Release Notes: about/release-notes.md - - Contributing: about/contributing.md - - Contact Us: about/contact-us.md - - License: about/license.md + #theme: material theme: @@ -40,15 +21,17 @@ theme: primary: 'purple' accent: 'indigo' language: 'en' + include_sidebar: true #logo: 'img/logo.png' #favicon: 'assets/images/favicon.ico' feature: - tabs: true + tabs: false + i18n: + prev: 'Previous' + next: 'Next' #Customization extra: - manifest: 'manifest.webmanifest' - #disqus: 'cap-1' social: - type: 'github' link: 'https://github.com/dotnetcore/cap' @@ -56,8 +39,6 @@ extra: link: 'https://twitter.com/ncc_community' - type: 'weibo' link: 'https://weibo.com/dotnetcore' -# search: -# language: 'en, zh' # Extensions markdown_extensions: @@ -89,4 +70,28 @@ markdown_extensions: - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true - - pymdownx.tilde \ No newline at end of file + - pymdownx.tilde + +nav: + - Home: index.md + - User Guide: + - Getting Started: user-guide/getting-started.md + - API Interface: user-guide/api-interface.md + - Configuration: user-guide/configuration.md + - Design Principle: user-guide/design.md + - Implementation Mechanisms: user-guide/implementation.md + - Distributed Transactions: user-guide/transaction.md + - FAQ: user-guide/faq.md + - 使用指南: + - 快速开始: user-guide-cn/getting-started.md + - API 接口: user-guide-cn/api-interface.md + - 配置: user-guide-cn/configuration.md + - 设计原理: user-guide-cn/design-principle.md + - 实现: user-guide-cn/implementation-mechanisms.md + - 分布式事务: user-guide-cn/distributed-transactions.md + - FAQ: user-guide-cn/faq.md + - About: + - Release Notes: about/release-notes.md + - Contributing: about/contributing.md + - Contact Us: about/contact-us.md + - License: about/license.md \ No newline at end of file