Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add docs-links-check ci and fix dead links #93

Merged
merged 1 commit into from
Jun 12, 2023

Conversation

Selflocking
Copy link
Member

@Selflocking Selflocking commented Jun 12, 2023

Fix: #92

This ci will run every saturday at 12:00 UTC

This ci can be manually triggered on the Action page

When modifying or adding docs in PR, the ci will run to check whether there is a dead link.

docs.links.check.config.json is the config file of this ci, refer to https://github.com/tcort/markdown-link-check#config-file-format .

There are ignorePatterns in the file for ignoring some links, for example:

[](overview)
[](/img/casbin.png)
[](http://localhost:8000)

This ci will run every saturday at 12:00 UTC

This ci can be manually triggered on the [Action page](https://github.com/casnode/casnode-website/actions/workflows/docs-links-check.yml)

When modifying or adding docs in PR, the ci will run to check whether there is a dead link.

`docs.links.check.config.json` is the config file of this ci, refer to https://github.com/tcort/markdown-link-check#config-file-format .

There are ignorePatterns in the file for ignoring some links, for example:

```md
[](overview)
[](/img/casbin.png)
[](http://localhost:8000)
```
@netlify
Copy link

netlify bot commented Jun 12, 2023

Deploy Preview for casnode ready!

Name Link
🔨 Latest commit c665be3
🔍 Latest deploy log https://app.netlify.com/sites/casnode/deploys/648737fa0b901c00088cedf7
😎 Deploy Preview https://deploy-preview-93--casnode.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@hsluoyz hsluoyz merged commit 5bc11be into casnode:master Jun 12, 2023
9 checks passed
Selflocking added a commit to Selflocking/casbin-website-v2 that referenced this pull request Jun 21, 2023
hsluoyz pushed a commit to casbin/casbin-website-v2 that referenced this pull request Jun 21, 2023
* feat: add docs-links-check ci and fix dead links

Similar to casnode/casnode-website#93

* fix: netlify preview build failed

* docs: fix dead links
hsluoyz pushed a commit to casbin/casbin-website-v2 that referenced this pull request Jun 27, 2023
* feat: add docs-links-check ci and fix dead links

Similar to casnode/casnode-website#93

* fix: netlify preview build failed

* docs: fix dead links
hsluoyz pushed a commit that referenced this pull request Jun 28, 2023
This ci will run every saturday at 12:00 UTC

This ci can be manually triggered on the [Action page](https://github.com/casnode/casnode-website/actions/workflows/docs-links-check.yml)

When modifying or adding docs in PR, the ci will run to check whether there is a dead link.

`docs.links.check.config.json` is the config file of this ci, refer to https://github.com/tcort/markdown-link-check#config-file-format .

There are ignorePatterns in the file for ignoring some links, for example:

```md
[](overview)
[](/img/casbin.png)
[](http://localhost:8000)
```
{
"ignorePatterns": [
{
"pattern": "^[^h]"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it is necessary to exclude strings starting with http or https, you can make the regular expression more specific to avoid matching other strings starting with 'h', such as 'help' ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs Link Check
3 participants