Skip to content

Commit

Permalink
README has clean lint
Browse files Browse the repository at this point in the history
  • Loading branch information
richelbilderbeek committed May 14, 2024
1 parent a094851 commit 2d791b8
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 3 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The software table is generated on each deploy on GitHub actions,
so you have to do that manually if you want to view it locally:

``` bash
python3 scripts/sw_table_md_creator.py -i https://export.uppmax.uu.se/staff/software_table_ci/software_table.json -o docs/software/software-table.md
./scripts/create_software_table.sh
```

### Text-to-speech
Expand Down Expand Up @@ -82,4 +82,3 @@ The website is created using
[mkdocs-material](https://squidfunk.github.io/mkdocs-material). The landing
page and layout was inspired by the documentation of the HPC cluster
[LUMI](https://docs.lumi-supercomputer.eu/).

24 changes: 24 additions & 0 deletions scripts/create_software_table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#!/bin/bash
#
# Create the software table.
#
# The software table is generated on each deploy on GitHub actions,
# so you have to do that manually if you want to view it locally:
#
# Usage:
#
# ./scripts/create_software_table.sh

if [[ "$PWD" =~ scripts$ ]]; then
echo "FATAL ERROR."
echo "Please run the script from the project root. "
echo "Present working director: $PWD"
echo " "
echo "Tip: like this"
echo " "
echo " ./scripts/create_software_table.sh"
echo " "
exit 42
fi

python3 scripts/sw_table_md_creator.py -i https://export.uppmax.uu.se/staff/software_table_ci/software_table.json -o docs/software/software-table.md
20 changes: 19 additions & 1 deletion scripts/fix_markdown_style_errors.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,24 @@ if [[ "$PWD" =~ scripts$ ]]; then
exit 42
fi

markdownlint '**/*.md' --ignore node_modules --fix
#
# This is too powerful, as it unindents:
#
#########################################
# ???- question "A question?"
#
# Some text that needs to be indented
#########################################
#
# to
#
#########################################
# ???- question "A question?"
#
# Some text that needs to be indented
#########################################
#

# markdownlint --fix '**/*.md' --ignore node_modules --fix

# ./scripts/remove_trailing_spaces.sh

0 comments on commit 2d791b8

Please sign in to comment.