From 5f7c2891028a00d3c7e2c82b1102d621ef5d2142 Mon Sep 17 00:00:00 2001 From: atteggiani Date: Fri, 26 Apr 2024 11:09:29 +1000 Subject: [PATCH] testing link checker --- .github/workflows/check_links.yml | 3 +-- README.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/check_links.yml b/.github/workflows/check_links.yml index f4fa5fe44..3200b532a 100644 --- a/.github/workflows/check_links.yml +++ b/.github/workflows/check_links.yml @@ -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' }} diff --git a/README.md b/README.md index 39efd1907..d1287e706 100644 --- a/README.md +++ b/README.md @@ -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.
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);