From 52cbd90d8d9815aeb1f706b1609a49cfdaf979fc Mon Sep 17 00:00:00 2001 From: kimulaco <11986753+kimulaco@users.noreply.github.com> Date: Fri, 16 Sep 2022 08:52:52 +0900 Subject: [PATCH] Fix incorrect URL hashes in documents (#6348) --- docs/developer-guide/syntaxes.md | 2 +- docs/migration-guide/to-14.md | 4 ++-- docs/user-guide/configure.md | 14 +++++++------- docs/user-guide/errors.md | 4 ++-- docs/user-guide/usage/cli.md | 26 +++++++++++++------------- 5 files changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/developer-guide/syntaxes.md b/docs/developer-guide/syntaxes.md index 8d5a962023..581e18eac9 100644 --- a/docs/developer-guide/syntaxes.md +++ b/docs/developer-guide/syntaxes.md @@ -1,6 +1,6 @@ # Writing custom syntaxes -Custom syntaxes are [PostCSS syntaxes](https://github.com/postcss/postcss#syntaxes) written by the community to support other styling languages and CSS-in-JS libraries using the [`customSyntax` option](../user-guide/usage/options.md#customSyntax). +Custom syntaxes are [PostCSS syntaxes](https://github.com/postcss/postcss#syntaxes) written by the community to support other styling languages and CSS-in-JS libraries using the [`customSyntax` option](../user-guide/usage/options.md#customsyntax). To write one, familiarize yourself with PostCSS's [how to write custom syntax](https://github.com/postcss/postcss/blob/main/docs/syntax.md) guide. diff --git a/docs/migration-guide/to-14.md b/docs/migration-guide/to-14.md index c80371af35..9fc35a79d6 100644 --- a/docs/migration-guide/to-14.md +++ b/docs/migration-guide/to-14.md @@ -47,7 +47,7 @@ There are other shared configs provided for each language: - [stylelint-config-recommended-vue](https://www.npmjs.com/package/stylelint-config-recommended-vue) ... Shared config for Vue. - [stylelint-config-html](https://www.npmjs.com/package/stylelint-config-html) ... Shared config that enables parsing for HTML, XML, Vue, Svelte, and PHP. -If a shared config isn't available for your preferred language or library, then you can install the appropriate [PostCSS syntax](https://github.com/postcss/postcss#syntaxes) yourself and use the [`customSyntax` option](../user-guide/usage/options.md#customSyntax), which is now available in the configuration object. +If a shared config isn't available for your preferred language or library, then you can install the appropriate [PostCSS syntax](https://github.com/postcss/postcss#syntaxes) yourself and use the [`customSyntax` option](../user-guide/usage/options.md#customsyntax), which is now available in the configuration object. For example, to lint [SugarSS](https://github.com/postcss/sugarss). @@ -138,7 +138,7 @@ The `function-calc-no-invalid` has been removed. You should remove it from your There are three changes that may affect you: - version 8 of PostCSS is now used in stylelint -- a [`disableFix` secondary option](../user-guide/configure.md#disableFix) was added +- a [`disableFix` secondary option](../user-guide/configure.md#disablefix) was added - TypeScript type definitions were added to the package ### PostCSS 8 diff --git a/docs/user-guide/configure.md b/docs/user-guide/configure.md index 9ae4e2569a..6c2425ffe6 100644 --- a/docs/user-guide/configure.md +++ b/docs/user-guide/configure.md @@ -320,7 +320,7 @@ For example: } ``` -[More info](usage/options.md#reportDescriptionlessDisables). +[More info](usage/options.md#reportdescriptionlessdisables). ## `reportInvalidScopeDisables` @@ -334,7 +334,7 @@ For example: } ``` -[More info](usage/options.md#reportInvalidScopeDisables). +[More info](usage/options.md#reportinvalidscopedisables). ## `reportNeedlessDisables` @@ -348,7 +348,7 @@ For example: } ``` -[More info](usage/options.md#reportNeedlessDisables). +[More info](usage/options.md#reportneedlessdisables). ## `ignoreDisables` @@ -362,7 +362,7 @@ For example: } ``` -[More info](usage/options.md#ignoreDisables). +[More info](usage/options.md#ignoredisables). ## `ignoreFiles` @@ -421,9 +421,9 @@ These properties provide extra validation for `stylelint-disable` comments. This The available reports are: -- [`reportDescriptionlessDisables`](#reportDescriptionlessDisables) -- [`reportInvalidScopeDisables`](#reportInvalidScopeDisables) -- [`reportNeedlessDisables`](#reportNeedlessDisables) +- [`reportDescriptionlessDisables`](#reportdescriptionlessdisables) +- [`reportInvalidScopeDisables`](#reportinvalidscopedisables) +- [`reportNeedlessDisables`](#reportneedlessdisables) They are configured like rules. They can have one of three values: diff --git a/docs/user-guide/errors.md b/docs/user-guide/errors.md index 2288fd5301..ad69f7e9a8 100644 --- a/docs/user-guide/errors.md +++ b/docs/user-guide/errors.md @@ -4,11 +4,11 @@ In addition to rule problems, Stylelint surfaces the following errors and warnin ## CSS syntax error -The chosen [PostCSS syntax](usage/options.md#customSyntax) was unable to parse the source. +The chosen [PostCSS syntax](usage/options.md#customsyntax) was unable to parse the source. ## Parse error -The chosen [PostCSS syntax](usage/options.md#customSyntax) successfully parsed, but one of the construct-specific parsers failed to parse either a media query, selector or value within that source. +The chosen [PostCSS syntax](usage/options.md#customsyntax) successfully parsed, but one of the construct-specific parsers failed to parse either a media query, selector or value within that source. The construct-specific parsers are: diff --git a/docs/user-guide/usage/cli.md b/docs/user-guide/usage/cli.md index 46d8ce75b6..54f4a8c4e0 100644 --- a/docs/user-guide/usage/cli.md +++ b/docs/user-guide/usage/cli.md @@ -14,11 +14,11 @@ The CLI accepts: ### `--allow-empty-input, --aei` -The process exits without throwing an error when glob pattern matches no files. [More info](options.md#allowEmptyInput). +The process exits without throwing an error when glob pattern matches no files. [More info](options.md#allowemptyinput). ### `--cache-location` -Path to a file or directory for the cache location. [More info](options.md#cacheLocation). +Path to a file or directory for the cache location. [More info](options.md#cachelocation). ### `--cache` @@ -30,19 +30,19 @@ Force enabling/disabling of color. ### `--config-basedir` -Absolute path to the directory that relative paths defining "extends" and "plugins" are _relative to_. Only necessary if these values are relative paths. [More info](options.md#configBasedir). +Absolute path to the directory that relative paths defining "extends" and "plugins" are _relative to_. Only necessary if these values are relative paths. [More info](options.md#configbasedir). ### `--config` -Path to a JSON, YAML, or JS file that contains your [configuration object](../configure.md). [More info](options.md#configFile). +Path to a JSON, YAML, or JS file that contains your [configuration object](../configure.md). [More info](options.md#configfile). ### `--custom-syntax` -Specify a custom syntax to use on your code. [More info](options.md#customSyntax). +Specify a custom syntax to use on your code. [More info](options.md#customsyntax). ### `--disable-default-ignores, --di` -Disable the default ignores. Stylelint will not automatically ignore the contents of `node_modules`. [More info](options.md#disableDefaultIgnores). +Disable the default ignores. Stylelint will not automatically ignore the contents of `node_modules`. [More info](options.md#disabledefaultignores). ### `--fix` @@ -54,11 +54,11 @@ Specify the formatter to format your results. [More info](options.md#formatter). ### `--ignore-disables, --id` -Ignore `stylelint-disable` (e.g. `/* stylelint-disable block-no-empty */`) comments. [More info](options.md#ignoreDisables). +Ignore `stylelint-disable` (e.g. `/* stylelint-disable block-no-empty */`) comments. [More info](options.md#ignoredisables). ### `--ignore-path, -i` -Path to a file containing patterns that describe files to ignore. The path can be absolute or relative to `process.cwd()`. You can repeat the option to provide multiple paths. By default, Stylelint looks for `.stylelintignore` in `process.cwd()`. [More info](options.md#ignorePath). +Path to a file containing patterns that describe files to ignore. The path can be absolute or relative to `process.cwd()`. You can repeat the option to provide multiple paths. By default, Stylelint looks for `.stylelintignore` in `process.cwd()`. [More info](options.md#ignorepath). ### `--ignore-pattern, --ip` @@ -66,7 +66,7 @@ Pattern of files to ignore (in addition to those in `.stylelintignore`). ### `--max-warnings, --mw` -Set a limit to the number of warnings accepted. [More info](options.md#maxWarnings). +Set a limit to the number of warnings accepted. [More info](options.md#maxwarnings). ### `--output-file, -o` @@ -82,19 +82,19 @@ Only register problems for rules with an "error"-level severity (ignore "warning ### `--report-descriptionless-disables, --rdd` -Produce a report of the `stylelint-disable` comments without a description. [More info](options.md#reportDescriptionlessDisables). +Produce a report of the `stylelint-disable` comments without a description. [More info](options.md#reportdescriptionlessdisables). ### `--report-invalid-scope-disables, --risd` -Produce a report of the `stylelint-disable` comments that used for rules that don't exist within the configuration object. [More info](options.md#reportInvalidScopeDisables). +Produce a report of the `stylelint-disable` comments that used for rules that don't exist within the configuration object. [More info](options.md#reportinvalidscopedisables). ### `--report-needless-disables, --rd` -Produce a report to clean up your codebase, keeping only the `stylelint-disable` comments that serve a purpose. [More info](options.md#reportNeedlessDisables). +Produce a report to clean up your codebase, keeping only the `stylelint-disable` comments that serve a purpose. [More info](options.md#reportneedlessdisables). ### `--stdin-filename` -A filename to assign the input. [More info](options.md#codeFilename). +A filename to assign the input. [More info](options.md#codefilename). ### `--stdin`