Browse Source

docs: add MkDocs file

Jackistang 4 năm trước cách đây
mục cha
commit
454906caff
2 tập tin đã thay đổi với 44 bổ sung0 xóa
  1. 19 0
      docs/index.md
  2. 25 0
      mkdocs.yml

+ 19 - 0
docs/index.md

@@ -0,0 +1,19 @@
+# MkLorum
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+[temp](demo.md#4)
+
+## 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.

+ 25 - 0
mkdocs.yml

@@ -0,0 +1,25 @@
+# 站点名
+site_name: HCI Middleware
+
+# 主题
+theme: readthedocs
+
+nav:
+  - Home: index.md
+  - 'Chipset':
+    - 'AP6212A': boards/AP6212A.md
+    - 'CSR8311': boards/CSR8311.md
+    - 'Zephyr':  boards/zephyr.md
+  - 'HCI':
+    - 'Data Format': HCI_dataformat.md
+    - 'Transport': HCI_Tramsport.md
+  - 'Others':
+    - 'qemu运行BLE': qemu.md
+    - 'ubuntu18.04 rtthread qemu 环境搭建': rtthread_ubuntu18.04_qemu环境搭建.md
+    - 'testcases': testcases.md
+    
+
+markdown_extensions:
+  - toc:
+      permalink: "#"
+      baselevel: 3