客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
开源软件名称（OpenSource Name）：DavidAnson/markdownlint开源软件地址(OpenSource Url)：https://github.com/DavidAnson/markdownlint开源编程语言(OpenSource Language)：JavaScript 98.6%开源软件介绍(OpenSource Introduction)：markdownlint
Installnpm install markdownlint --save-devOverviewThe Markdown markup language is designed to be easy to read, write, and understand. It succeeds - and its flexibility is both a benefit and a drawback. Many styles are possible, so formatting can be inconsistent. Some constructs don't work well in all parsers and should be avoided. The CommonMark specification standardizes parsers - but not authors.
Related
Demonstration
Rules / Aliases
See Rules.md for more details.
TagsTags group related rules and can be used to enable/disable multiple rules at once.
ConfigurationText passed to
Rules can be enabled, disabled, and configured via
For example: <!-- markdownlint-disable-next-line no-space-in-emphasis -->
deliberate space * in * emphasisOr: deliberate space * in * emphasis <!-- markdownlint-disable-line no-space-in-emphasis -->Or: <!-- markdownlint-disable no-space-in-emphasis -->
deliberate space * in * emphasis
<!-- markdownlint-enable no-space-in-emphasis -->To temporarily disable rule(s), then restore the former configuration: <!-- markdownlint-capture -->
<!-- markdownlint-disable -->
any violations you want
<!-- markdownlint-restore -->The initial configuration is captured by default (as if every document
began with <!-- markdownlint-disable -->
any violations you want
<!-- markdownlint-restore -->Changes take effect starting with the line a comment is on, so the following has no effect: space * in * emphasis <!-- markdownlint-disable --> <!-- markdownlint-enable -->To apply changes to an entire file regardless of where the comment is located, the following syntax is supported:
This can be used to "hide" In cases where it is desirable to change the configuration of one or more rules for a file, the following more advanced syntax is supported:
For example: <!-- markdownlint-configure-file { "MD013": { "code_blocks": false } } -->or <!-- markdownlint-configure-file
{
"hr-style": {
"style": "---"
},
"no-trailing-spaces": false
}
-->These changes apply to the entire file regardless of where the comment is
located. Multiple such comments (if present) are applied top-to-bottom. By
default, content of APILintingStandard asynchronous API: /**
* Lint specified Markdown files.
*
* @param {Options} options Configuration options.
* @param {LintCallback} callback Callback (err, result) function.
* @returns {void}
*/
function markdownlint(options, callback) { ... }Synchronous API (for build scripts, etc.): /**
* Lint specified Markdown files synchronously.
*
* @param {Options} options Configuration options.
* @returns {LintResults} Results object.
*/
function markdownlint.sync(options) { ... }Promise API (in the /**
* Lint specified Markdown files.
*
* @param {Options} options Configuration options.
* @returns {Promise<LintResults>} Results object.
*/
function markdownlint(options) { ... }optionsType: Configures the function. All properties are optional, but at least one
of options.configType: Configures the rules to use. Object keys are rule names or aliases and values are the rule's configuration.
The value The Example: {
"default": true,
"MD003": { "style": "atx_closed" },
"MD007": { "indent": 4 },
"no-hard-tabs": false,
"whitespace": false
}See .markdownlint.jsonc and/or .markdownlint.yaml for an example configuration object with all properties set to the default value. Sets of rules (known as a "style") can be stored separately and loaded as JSON. Example: const options = {
"files": [ "..." ],
"config": require("style/relaxed.json")
};See the style directory for more samples. See markdownlint-config-schema.json
for the JSON Schema of the For more advanced scenarios, styles can reference and extend other styles.
The For example, assuming a {
"default": true
}And a {
"extends": "base.json",
"line-length": false
}Then code like the following: const options = {
"config": markdownlint.readConfigSync("./custom.json")
};Merges const options = {
"config": {
"default": true,
"line-length": false
}
};options.configParsersType: Optional Array of functions to parse the content of As shown in the Configuration section, inline comments can be
used to customize the configuration object for a document. By
default, the For example: [ JSON.parse, require("toml").parse, require("js-yaml").load ]options.customRulesType: List of custom rules to include with the default rule set for linting. Each array element should define a rule. Rules are typically exported
by another package, but can be defined locally. Custom rules are
identified by the
keyword Example: const extraRules = require("extraRules");
const options = {
"customRules": [ extraRules.one, extraRules.two ]
};See CustomRules.md for details about authoring custom rules. options.filesType: List of files to lint. Each array element should be a single file (via relative or absolute path); globbing is the caller's responsibility. Example: options.frontMatterType: Matches any front matter found at the beginning of a file. Some Markdown content begins with metadata; the default The default value: /((^---\s*$[^]*?^---\s*$)|(^\+\+\+\s*$[^]*?^(\+\+\+|\.\.\.)\s*$)|(^\{\s*$[^]*?^\}\s*$))(\r\n|\r|\n|$)/mIgnores YAML, TOML, and JSON front matter such as: Note: Matches must occur at the start of the file. options.fsType: In advanced scenarios, it may be desirable to bypass the default file system API.
If a custom file system implementation is provided, Note: The only methods called are options.handleRuleFailuresType: Catches exceptions thrown during rule processing and reports the problem as a rule violation. By default, exceptions thrown by rules (or the library itself) are unhandled
and bubble up the stack to the caller in the conventional manner. By setting
options.markdownItPluginsType: Specifies additional markdown-it plugins to use when parsing input. Plugins can be used to support additional syntax and features for advanced scenarios. Each item in the top-level [ require("markdown-it-plugin"), plugin_param_0, plugin_param_1, ... ]options.noInlineConfigType: Disables the use of HTML comments like By default, properly-formatted inline comments can be used to create exceptions
for parts of a document. Setting options.resultVersionType: Specifies which version of the Passing a Passing a Passing a Passing a options.stringsType: Map of identifiers to strings for linting. When Markdown content is not available as files, it can be passed as
strings. The keys of the Example: {
"readme": "# README\n...",
"changelog": "# CHANGELOG\n..."
}callbackType: Standard completion callback. resultType: Call ConfigThe By default, configuration files are parsed as JSON (and named Asynchronous API: /**
* Read specified configuration file.
*
* @param {string} file Configuration file name.
* @param {ConfigurationParser[] | ReadConfigCallback} parsers Parsing function(s).
* @param {Object} [fs] File system implementation.
* @param {ReadConfigCallback} [callback] Callback (err, result) function.
* @returns {void}
*/
function readConfig(file, parsers, fs, callback) { ... }Synchronous API: /**
* Read specified configuration file synchronously.
*
* @param {string} file Configuration file name.
* @param {ConfigurationParser[]} [parsers] Parsing function(s).
* @param {Object} [fs] File system implementation.
* @returns {Configuration} Configuration object.
*/
function readConfigSync(file, parsers, fs) { ... }Promise API (in the |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
六六分期app的软件客服如何联系？不知道吗？加qq群【895510560】即可！标题：六六分期
今天小编告诉大家如何处理win10系统火狐flash插件总是崩溃的问题，可能很多用户都不知
今天小编告诉大家如何对win10系统删除桌面回收站图标进行设置，可能很多用户都不知道
今天小编告诉大家如何对win10系统电脑设置节能降温的设置方法，想必大家都遇到过需要
我们在使用xp系统的过程中,经常需要对xp系统无线网络安装向导设置进行设置，可能很多
今天小编告诉大家如何处理win7系统玩cf老是与主机连接不稳定的问题，可能很多用户都不
电脑对日常生活的重要性小编就不多说了，可是一旦碰到win7系统设置cf烟雾头的问题，很
我们在日常使用电脑的时候，有的小伙伴们可能在打开应用的时候会遇见提示应用程序无法
今天小编告诉大家如何对win7系统打开vcf文件进行设置，可能很多用户都不知道怎么对win
今天小编告诉大家如何对win10系统s4开启USB调试模式进行设置，可能很多用户都不知道怎
请发表评论