{"_id":"@bxf1234/markdownlint-config","name":"@bxf1234/markdownlint-config","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@bxf1234/markdownlint-config","version":"1.0.0","description":"markdown lint","keywords":["markdown","lint"],"author":{"name":"bxf","email":"xybaoxiangfei@163.com"},"homepage":"https://github.com/baoxfei/lint-configs#readme","license":"ISC","main":"index.json","publishConfig":{"registry":"https://registry.npmjs.org/","access":"public"},"repository":{"type":"git","url":"git+https://github.com/baoxfei/lint-configs.git"},"scripts":{},"bugs":{"url":"https://github.com/baoxfei/lint-configs/issues"},"peerDependencies":{"markdownlint":"^0.35.0"},"gitHead":"9c4fe2035cb7ae6fbf672e60d49a41914a459c03","_id":"@bxf1234/markdownlint-config@1.0.0","_nodeVersion":"16.19.0","_npmVersion":"8.19.3","dist":{"integrity":"sha512-Uqw26ymNU6hF1b54xJG4gpPC5g4I8wJNFoztwz7J23ua3hsY47qMKhgE6N6eYP0BZJiAvNJYjSPVztaPTCl84Q==","shasum":"f7f5039dcf6aef3a754c41b02da9d685398c0194","tarball":"https://registry.npmjs.org/@bxf1234/markdownlint-config/-/markdownlint-config-1.0.0.tgz","fileCount":3,"unpackedSize":5017,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEspp8v4sEvZ75jei71nhT+AjqFML6mezotvu8zIAhPmAiEA/uqZMjeXsOEC8cNiMFpIPDmIDI5P0qXXREwi/WxogCg="}]},"_npmUser":{"name":"bxf1234","email":"xybaoxiangfei@163.com"},"directories":{},"maintainers":[{"name":"bxf1234","email":"xybaoxiangfei@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/markdownlint-config_1.0.0_1730208573665_0.9428889428245706"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-29T13:29:33.546Z","1.0.0":"2024-10-29T13:29:33.856Z","modified":"2024-10-29T13:29:34.173Z"},"maintainers":[{"name":"bxf1234","email":"xybaoxiangfei@163.com"}],"description":"markdown lint","homepage":"https://github.com/baoxfei/lint-configs#readme","keywords":["markdown","lint"],"repository":{"type":"git","url":"git+https://github.com/baoxfei/lint-configs.git"},"author":{"name":"bxf","email":"xybaoxiangfei@163.com"},"bugs":{"url":"https://github.com/baoxfei/lint-configs/issues"},"license":"ISC","readme":"# markdownlint-config-lx\n\n> lx markdownlint 共享配置\n\n## 使用\n\n```bash\nnpm install --save-dev markdownlint @baoxf/markdownlint-config\n```\n\n安装完成之后 在 `.markdownlint.json` 配置如下\n\n```json\n{\n  \"extends\": \"markdownlint-config-lx\"\n}\n```\n\n## 解释\n\n1. ul-style 无序列表 使用什么\n   List style (string, default consistent, values asterisk / consistent(一直使用一种) / dash / plus / sublist)\n\n2. MD010 no-hard-tabs\n   不允许使用tab 进行缩进\n\n3. MD011 no-reversed-links\n   链接在 () 里，文字在 [] 里\n\n4. MD014 Dollar signs used before commands without showing output\n   在文档中为了展示命令，很多人习惯性地在命令前加上 $，但如果仅展示命令而不展示其输出，添加 $ 符号会带来困惑，因为这意味着命令行的提示符。如果只展示命令的时候，不建议使用 $，如果有输出 可以使用 $ 。\n\n5. MD034 Bare URL used\n   单独的写链接 需要加上, 例如：<https://www.example.com>\n\n6. MD054: Reference links and images should use a label that is defined\n   引用链接 需要 已经定义好的标签\n\n   ```md\n    这是一个[链接][已定义标签]。\n\n    ![图片描述][已定义图片标签]\n\n    [已定义标签]: https://example.com\n    [已定义图片标签]: https://example.com/image.png\n   ```\n\n7. MD053 Link and image reference definitions should be needed\n  标签定义了应该使用\n\n## 总述\n\nmarkdownlint 主要就是对 table、whitespace、title、img、ul、strong、emphasis和代码块等书写的规范和建议\n\ntable： 上下有`black_line`、需要有 ｜ 作为表格的开始和结尾、每一行列一致\n\nimg：要有alt、 \n\nlink： 超链接 要使用 `[]()`、单独链接要使用 `<>`、\n\ntitle：一页开头 需要是 一级标题、标题不要跳级、开头有空格、结尾不能有标点、使用 `#` 代表标题、不能有emphasis、上下有 `black_line`\n\nul： 有序 要有序、无序用 `-`、上下有 `black_line`\n\ncode-block: 使用 ` ```js ` 作为代码块、上下有 `black_line`\n","readmeFilename":"README.md"}