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
52e0a02a
Commit
52e0a02a
authored
3 years ago
by
Martin Schroschk
Browse files
Options
Downloads
Patches
Plain Diff
Document syntax highlighting
parent
39bd4e50
No related branches found
No related tags found
3 merge requests
!322
Merge preview into main
,
!319
Merge preview into main
,
!187
Syntax highlighting
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc.zih.tu-dresden.de/README.md
+39
-1
39 additions, 1 deletion
doc.zih.tu-dresden.de/README.md
with
39 additions
and
1 deletion
doc.zih.tu-dresden.de/README.md
+
39
−
1
View file @
52e0a02a
...
@@ -400,6 +400,44 @@ rules have to be followed.
...
@@ -400,6 +400,44 @@ rules have to be followed.
*
No output: Omit prompt (copy-paste)
*
No output: Omit prompt (copy-paste)
*
With Output: Add prompt (make clear what is the command and what is the output)
*
With Output: Add prompt (make clear what is the command and what is the output)
#### Code Blocks and Syntax Highlighting
This project makes use of the extension
[
pymdownx.highlight
](
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
)
for syntax
highlighting.
There is complete list of supported
[
language short codes
](
https://pygments.org/docs/lexers/
)
.
Use the following short codes within this project for consistency:
*
`{bash}`
for shell scripts
*
`{shell-session}`
for command lines including prompt
*
`{python}`
for Python source code
Line numbers can be added via
```
bash linenums="1"
#!/bin/bash
#SBATCH -N 1
#SBATCH -n 23
#SBATCH -t 02:10:00
srun a.out
```
and specific Lines can be highlighted by using
```
bash hl_lines="2 3"
#!/bin/bash
#SBATCH -N 1
#SBATCH -n 23
#SBATCH -t 02:10:00
srun a.out
```
### Data Privacy and Generic User Name
### Data Privacy and Generic User Name
Where possible, replace login, project name and other private data with clearly arbitrary placeholders.
Where possible, replace login, project name and other private data with clearly arbitrary placeholders.
...
@@ -418,7 +456,7 @@ If showing only a snippet of a long output, omissions are marked with `[...]`.
...
@@ -418,7 +456,7 @@ If showing only a snippet of a long output, omissions are marked with `[...]`.
### Mark Placeholders
### Mark Placeholders
Stick to the Unix rules on optional and required arguments, and se
c
lection of item sets.
Stick to the Unix rules on optional and required arguments, and selection of item sets.
*
`<required argument or value>`
*
`<required argument or value>`
*
`[optional argument or value]`
*
`[optional argument or value]`
...
...
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