Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
hpc-compendium
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ZIH
hpcsupport
hpc-compendium
Commits
6ed6636c
Commit
6ed6636c
authored
3 years ago
by
Jan Frenzel
Browse files
Options
Downloads
Patches
Plain Diff
Added docker commands for invoking markdownlint and markdown-link-check.
parent
76b71827
No related branches found
Branches containing commit
No related tags found
3 merge requests
!322
Merge preview into main
,
!319
Merge preview into main
,
!211
Added information about how to use the Dockerfile to serve the documentation.
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/README.md
+10
-0
10 additions, 0 deletions
doc.zih.tu-dresden.de/README.md
with
10 additions
and
0 deletions
doc.zih.tu-dresden.de/README.md
+
10
−
0
View file @
6ed6636c
...
@@ -133,6 +133,16 @@ docker run -it hpc-compendium mkdocs serve -a 0.0.0.0:8000
...
@@ -133,6 +133,16 @@ docker run -it hpc-compendium mkdocs serve -a 0.0.0.0:8000
docker inspect `docker ps | grep hpc-compendium | cut -d' ' -f1` | sed -n '/\<IPAd/s#^.*"\([0-9.]*\)".*$#http://\1:8000#p' | head -n1
docker inspect `docker ps | grep hpc-compendium | cut -d' ' -f1` | sed -n '/\<IPAd/s#^.*"\([0-9.]*\)".*$#http://\1:8000#p' | head -n1
```
```
If you want to check whether the markdown files are formatted properly, use the following command:
```
Bash
docker run -it hpc-compendium markdownlint docs
```
To check whether there are links that point to a wrong target, use (this may take a while and gives a lot of output because it runs over all files):
```
Bash
docker run -it hpc-compendium bash -c "find docs -type f -name '*.md' | xargs -L1 markdown-link-check"
```
#### Build Static Documentation
#### Build Static Documentation
To build the documentation, invoke
`mkdocs build`
. This will create a new directory named
`public`
To build the documentation, invoke
`mkdocs build`
. This will create a new directory named
`public`
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment