From f6a94be67a7183d2c80a4e8475716bd4f42a6467 Mon Sep 17 00:00:00 2001 From: Lemmy Huang Date: Fri, 15 Sep 2023 15:03:17 +0800 Subject: [PATCH] add mkdocs Signed-off-by: Lemmy Huang --- .gitignore | 3 +++ docs/README.md | 36 ++++++++++++++++++++++++++++++++++++ docs/index.md | 19 +++++++++++++++++++ mkdocs.yml | 19 +++++++++++++++++++ 4 files changed, 77 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.gitignore b/.gitignore index e224a09..e8107b5 100644 --- a/.gitignore +++ b/.gitignore @@ -29,3 +29,6 @@ *~ .*.swp + +/site/ + diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..339fc23 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,36 @@ + + +## GMEM主页编辑 + +* 安装mkdocs + + ```sh + pip install mkdocs + # Print help message + mkdocs -h + ``` + +* 网页组成 + + ```sh + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. + site/ + index.html # 由mkdocs生成的静态网页，托管到gh-pages分支 + ... + ``` + +* 在本地查看网页 + + ```sh + mkdocs serve + ``` + +* 更新网页到gh-pages分支 + + ```sh + mkdocs gh-deploy --force --no-history -f ./mkdocs.yml + ``` + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a71161a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,19 @@ +# Welcome to GMEM + + + +## 简介 + +TODO + +## 架构 + +TODO + +## 社区 + +TODO + +## 联系我们 + +TODO diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..a726da1 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,19 @@ +# Project information +site_name: GMEM +site_url: http://gmem.tech +site_author: dev@openeuler.org + +# Repository +repo_name: openEuler/libgmem +repo_url: https://gitee.com/openeuler/libgmem +edit_uri: https://gitee.com/openeuler/libgmem/tree/master/docs + +# Copyright +copyright: Copyright © 2023 openEuler GMEM team + +# Pages +nav: +- Home: index.md + +theme: + name: mkdocs -- Gitee