File tree Expand file tree Collapse file tree 2 files changed +43
-1
lines changed Expand file tree Collapse file tree 2 files changed +43
-1
lines changed Original file line number Diff line number Diff line change 1+ name : Publish Docs
2+ on :
3+ push :
4+ tags :
5+ - ' test*.*.*'
6+ workflow_dispatch :
7+ jobs :
8+ publish-docs :
9+ runs-on : ubuntu-latest
10+ env :
11+ DOCKER_CLIENT_TIMEOUT : " 120"
12+ COMPOSE_HTTP_TIMEOUT : " 120"
13+ steps :
14+ - uses : actions/checkout@v2
15+ - name : Deploy docs
16+ run : |
17+ export MODE=BUILD
18+ export PACKAGE=datajoint
19+ export UPSTREAM_REPO=https://github.com/${GITHUB_REPOSITORY}.git
20+ export HOST_UID=$(id -u)
21+ docker compose -f docs/docker-compose.yaml up --exit-code-from docs --build
22+ git push origin gh-pages
Original file line number Diff line number Diff line change @@ -6,7 +6,27 @@ settings files, that were used in developing these docs:
66- [ MarkdownLinter] ( https://github.com/DavidAnson/markdownlint ) :
77 - ` .markdownlint.yaml ` establishes settings for various
88 [ linter rules] ( https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md )
9- - ` .vscode/settings.json ` formatting on save to fix linting
9+ - ` .vscode/settings.json ` formatting settings
10+
11+ ``` json
12+ {
13+ "[markdown]" : {
14+ "editor.rulers" : [88 ],
15+ "editor.formatOnPaste" : true ,
16+ "editor.formatOnSave" : true ,
17+ // https://github.com/stkb/Rewrap/
18+ // Toggle via command prompt per file
19+ // Default paragraph rewrap key: alt+q or option+q
20+ "rewrap.autoWrap.enabled" : true ,
21+ "rewrap.wrappingColumn" : 88
22+ },
23+ // https://github.com/DavidAnson/markdownlint
24+ "editor.codeActionsOnSave" : {
25+ "source.fixAll.markdownlint" :true
26+ },
27+ "markdownlint.focusMode" : 5 , // ignore issues around the cursor
28+ }
29+ ```
1030
1131- [ CSpell] ( https://github.com/streetsidesoftware/vscode-spell-checker ) : ` cspell.json `
1232has various ignored words.
You can’t perform that action at this time.
0 commit comments