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

Please the Markdown Linter via Cleanup. #44

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

FSG-Cat
Copy link
Member

@FSG-Cat FSG-Cat commented Dec 18, 2024

This PR pleases the markdown linter via a general cleanup of errors it found. Tho if a error in its regards is invalid as far as im concerned its ignored.

@FSG-Cat FSG-Cat closed this Dec 18, 2024
@FSG-Cat FSG-Cat force-pushed the FSG-Cat/markdown-lint branch from e8ac2e1 to 7e5a3c0 Compare December 18, 2024 16:48
@FSG-Cat FSG-Cat reopened this Dec 18, 2024
@FSG-Cat FSG-Cat force-pushed the FSG-Cat/markdown-lint branch from f9089c3 to 1e43478 Compare December 18, 2024 17:14
docs/bot/synapse_module.md Outdated Show resolved Hide resolved
@@ -138,7 +138,7 @@ If you need to debug an issue that is occurring through use in matrix,
say the unban command has stopped working, you can launch
mjolnir from the JavaScript Debug Terminal using `yarn test:manual`.
This will launch mjolnir using the config found in `config/harness.yaml`.
You can now open https://app.element.io, change the server to `localhost:8081`,
You can now open [https://app.element.io](https://app.element.io), change the server to `localhost:8081`,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
You can now open [https://app.element.io](https://app.element.io), change the server to `localhost:8081`,
You can now open <https://app.element.io>, change the server to `localhost:8081`,

Copy link
Member Author

Choose a reason for hiding this comment

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

Quick way to trigger a build failure. I did exactly this before and it triggers a build failure.

Choose a reason for hiding this comment

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

<link> isn't valid commonmark last I checked.

Copy link
Member Author

Choose a reason for hiding this comment

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

The markdown linter thought it was fine but Docusaurus wont think that and will trigger a build failure.

Copy link
Contributor

Choose a reason for hiding this comment

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

<link> isn't valid commonmark last I checked.

It's valid commonmark. Search "autolink" in spec. Iirc it's even only part of commonmark and not others.

https://spec.commonmark.org/0.31.2/#autolinks

Copy link
Contributor

Choose a reason for hiding this comment

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

The markdown linter thought it was fine but Docusaurus wont think that and will trigger a build failure.

Smells like they parse mdx rather than commonmark markdown 👀

Copy link
Member

Choose a reason for hiding this comment

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

By default, Docusaurus v3 uses the MDX format for all files

https://docusaurus.io/docs/markdown-features

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.

4 participants