JuliaDocs/Documenter.jl

Markdown AST linting

Open

#2,059 创建于 2023年3月6日

在 GitHub 查看
 (0 评论) (1 反应) (0 负责人)Julia (513 fork)batch import
Type: Featurehelp wanted

仓库指标

Star
 (910 star)
PR 合并指标
 (平均合并 16天 9小时) (30 天内合并 3 个 PR)

描述

There are some common errors people make with Markdown that are pretty clearly errors, but parse into valid AST (everything does), and so go unnoticed (e.g. forgetting to have closing fences for code blocks). We could implement a linting mode for Documenter, as part of docchecks, that tries to catch these.

Two steps for a useful feature:

  • A new linting step as part of docchecking. Key here is that it should be possible to disable this on its own (e.g. if you get false positives).
  • The code fence closing linter should be relatively straightforward to implement.

Suggested by @giordano: https://github.com/JuliaLang/julia/pull/48893#issuecomment-1455197197

贡献者指南