Skip to content

Commit f788942

Browse files
author
Xianpeng Shen
committed
Update mkdocs
1 parent 5af3116 commit f788942

File tree

3 files changed

+2
-4
lines changed

3 files changed

+2
-4
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## How to build the docs
2+
23
From the root directory of the repository, do the following to steps
34

45
1. Install docs' dependencies

docs/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,3 @@
2121
start="<!--footer-start-->"
2222
end="<!--footer-end-->"
2323
%}
24-
{%
25-
include-markdown "README.md"
26-
%}

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: C/C++ Linter Action's Docs
1+
site_name: C/C++ Linter Action
22
site_description: "Developer documentation from sources."
33
site_url: "https://shenxianpeng.github.io/cpp-linter-action"
44
repo_url: "https://github.com/shenxianpeng/cpp-linter-action"

0 commit comments

Comments
 (0)