forensicswiki / wiki

Forensics Wiki, a wiki devoted to information about digital forensics (also known as computer forensics)
https://forensics.wiki
Other
251 stars 31 forks source link

Consider adding markdown lint GitHub action #21

Open joachimmetz opened 2 years ago

joachimmetz commented 2 years ago

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

obsidianforensics commented 1 year ago

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 commented 1 year ago

Experimenting with dead link checks https://github.com/forensicswiki/wiki/pull/51

This also raises a question: what do we do with dead links and out dated information e.g. https://github.com/forensicswiki/wiki/pull/52

I propose:

Also see: https://github.com/forensicswiki/wiki/discussions/54

joachimmetz commented 1 year ago

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