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

Consider adding markdown lint GitHub action #21

Open
joachimmetz opened this issue Oct 22, 2022 · 3 comments
Open

Consider adding markdown lint GitHub action #21

joachimmetz opened this issue Oct 22, 2022 · 3 comments

Comments

@joachimmetz
Copy link
Collaborator

Consider adding markdown lint GitHub action to catch markdown formatting errors early

@obsidianforensics
Copy link
Collaborator

Along with the linter, it would be good to decide on some style guide items for it to enforce.

A few I've been thinking of:

I've also been noticing some differences between GitHub's previews of the Markdown pages and what gets generated for the live site. I believe Material for MkDocs (which we use) uses python-markdown to convert the Markdown files to HTML, so it would be good to explore the differences between that library and how GitHub renders .mk files to avoid confusion/frustration when contributors make edits that don't render as they expect.

@joachimmetz
Copy link
Collaborator Author

joachimmetz commented Dec 18, 2022

Experimenting with dead link checks #51

This also raises a question: what do we do with dead links and out dated information e.g. #52

I propose:

  • to remove references to dead links if no alternative is available
  • to remove out dated information

Also see: #54

@joachimmetz
Copy link
Collaborator Author

@obsidianforensics Are there tools to automatically (re)format markdown? That might be beneficial to keep things consistent

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

No branches or pull requests

2 participants