File tree 6 files changed +70
-1
lines changed
6 files changed +70
-1
lines changed Original file line number Diff line number Diff line change
1
+ name : ci
2
+
3
+ on :
4
+ push :
5
+ branches :
6
+ - main
7
+ - proper-docs
8
+
9
+ permissions :
10
+ contents : write
11
+
12
+ jobs :
13
+ deploy :
14
+ runs-on : ubuntu-latest
15
+ steps :
16
+ - uses : actions/checkout@v4
17
+
18
+ - uses : arduino/setup-task@v2
19
+ with :
20
+ version : 3.x
21
+ repo-token : ${{ secrets.GITHUB_TOKEN }}
22
+
23
+ - name : setup
24
+ run : task docs:deploy
Original file line number Diff line number Diff line change 12
12
],
13
13
"[go]" : {
14
14
"editor.formatOnSave" : true ,
15
- }
15
+ },
16
+ "yaml.schemas" : {
17
+ "https://squidfunk.github.io/mkdocs-material/schema.json" : " mkdocs.yml"
18
+ },
19
+ "yaml.customTags" : [
20
+ " !ENV scalar" ,
21
+ " !ENV sequence" ,
22
+ " !relative scalar" ,
23
+ " tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg" ,
24
+ " tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji" ,
25
+ " tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
26
+ ]
16
27
}
Original file line number Diff line number Diff line change
1
+ FROM squidfunk/mkdocs-material
Original file line number Diff line number Diff line change @@ -27,6 +27,18 @@ tasks:
27
27
generates :
28
28
- ./scm-engine
29
29
30
+ docs:server :
31
+ desc : Run Docs dev server with live preview
32
+ cmds :
33
+ - docker build -t scm-engine-docs -f Dockerfile.docs .
34
+ - docker run --rm -it -p 8000:8000 -v ${PWD}:/docs scm-engine-docs serve -o --watch-theme -w /docs --dev-addr 0.0.0.0:8000
35
+
36
+ docs:deploy :
37
+ desc : Deploy GitHub pages docs
38
+ cmds :
39
+ - docker build -t scm-engine-docs -f Dockerfile.docs .
40
+ - docker run --rm -v ${PWD}:/docs scm-engine-docs gh-deploy --force
41
+
30
42
test :
31
43
desc : Run tests
32
44
env :
Original file line number Diff line number Diff line change
1
+ # Welcome to MkDocs
2
+
3
+ For full documentation visit [ mkdocs.org] ( https://www.mkdocs.org ) .
4
+
5
+ ## Commands
6
+
7
+ * ` mkdocs new [dir-name] ` - Create a new project.
8
+ * ` mkdocs serve ` - Start the live-reloading docs server.
9
+ * ` mkdocs build ` - Build the documentation site.
10
+ * ` mkdocs -h ` - Print help message and exit.
11
+
12
+ ## Project layout
13
+
14
+ mkdocs.yml # The configuration file.
15
+ docs/
16
+ index.md # The documentation homepage.
17
+ ... # Other markdown pages, images and other files.
Original file line number Diff line number Diff line change
1
+ site_name : SCM Engine Docs
2
+
3
+ theme :
4
+ name : material
You can’t perform that action at this time.
0 commit comments