Skip to content

Commit

Permalink
testing link checker
Browse files Browse the repository at this point in the history
  • Loading branch information
atteggiani committed Apr 26, 2024
1 parent d35c160 commit 5f7c289
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/check_links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ jobs:
fail: true
format: 'markdown'
jobSummary: false
# args: --config .github/workflows/lychee-config.toml './**/*.md' './**/*.html'
args: --config .github/workflows/lychee-config.toml 'docs/models/model_components/bgc_ocean.md'
args: --config .github/workflows/lychee-config.toml './**/*.md' './**/*.html'

# scheduled-link-check:
# if: ${{ github.event_name == 'schedule' }}
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ If you wish to add documentation to the ACCESS-Hive website see the [contributio
## Styling guidelines for contribution
Please follow the guidelines below so as to make the Hive consistent among the pages contributed by different people.

- All links need to be ABSOLUTE links (starting with `/` which indicates the `docs` directory). This because currently the link checker does not handle relative links properly.
- Always prefer HTML syntax to Markdown when possible;
- Titles/subtitles should NOT include: code lines/blocks, bold (titles are usually already bold), italic, links;
- Code lines/blocks need to be used for lines/blocks of code and terminal commands;
- Italic needs to be used when referring to specific proper nouns (for example *Gadi* or *Accessdev*);
- Bold can be used to highlight some words (please do not overuse it);
- Links should be coded using HTML syntax.<br>External links (links that go to a website other than https://access-hive.org.au) need to specify `target="_blank"` (see HTML cheatsheet below);
- To signal an important note within the text, consider using a "warning note" (see HTML cheatsheet below);
- Instructions for different versions (for example different operative systems or different model versions) can be rendered using tabs (see HTML cheatsheet below);

Expand Down

0 comments on commit 5f7c289

Please sign in to comment.