Skip to content

Commit

Permalink
Refactor docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Dec 13, 2023
1 parent 3d11bb5 commit 547188e
Show file tree
Hide file tree
Showing 299 changed files with 11,021 additions and 8,117 deletions.
22 changes: 16 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"private": true,
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/remarkjs/remark-lint"
},
"repository": "https://github.com/remarkjs/remark-lint",
"bugs": "https://github.com/remarkjs/remark-lint/issues",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/unified"
},
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"contributors": [
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
Expand Down Expand Up @@ -117,12 +118,17 @@
"@ungap/structured-clone": "^1.0.0",
"c8": "^8.0.0",
"comment-parser": "^1.0.0",
"control-pictures": "^2.0.0",
"estree-util-is-identifier-name": "^3.0.0",
"github-slugger": "^2.0.0",
"mdast-util-find-and-replace": "^3.0.0",
"mdast-util-from-markdown": "^2.0.0",
"mdast-util-gfm": "^3.0.0",
"mdast-util-to-markdown": "^2.0.0",
"mdast-util-to-string": "^4.0.0",
"mdast-zone": "^6.0.0",
"micromark-extension-gfm": "^3.0.0",
"micromark-util-normalize-identifier": "^2.0.0",
"parse-author": "^2.0.0",
"prettier": "^3.0.0",
"remark": "^15.0.0",
Expand All @@ -133,17 +139,21 @@
"remark-toc": "^9.0.0",
"remark-validate-links": "^13.0.0",
"strip-indent": "^4.0.0",
"to-vfile": "^8.0.0",
"type-coverage": "^2.0.0",
"type-fest": "^4.0.0",
"typescript": "^5.0.0",
"unified": "^11.0.0",
"unist-builder": "^4.0.0",
"unist-util-remove-position": "^5.0.0",
"vfile": "^6.0.0",
"vfile-find-down": "^7.0.0",
"vfile-reporter": "^8.0.0",
"vfile-sort": "^4.0.0",
"xo": "^0.56.0"
},
"scripts": {
"generate": "node --conditions development script/build-plugins.js && node --conditions development script/build-presets.js",
"generate": "node --conditions development script/build-packages.js",
"build": "tsc --build --clean && tsc --build && type-coverage",
"format": "remark . --frail --output --quiet && prettier . --log-level warn --write && xo --fix",
"test": "npm run build && npm run generate && npm run format && npm run test-coverage",
Expand All @@ -152,8 +162,8 @@
},
"prettier": {
"bracketSpacing": false,
"singleQuote": true,
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "none",
"useTabs": false
Expand Down
2 changes: 2 additions & 0 deletions packages/remark-lint-blockquote-indentation/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
ignore-scripts=true
package-lock=false
46 changes: 35 additions & 11 deletions packages/remark-lint-blockquote-indentation/index.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,41 @@
/**
* remark-lint rule to warn when block quotes are indented too much or
* too little.
*
* ## What is this?
*
* This package checks the “indent” of block quotes: the `>` (greater than)
* marker *and* the spaces before content.
*
* ## When should I use this?
*
* You can use this package to check that the “indent” of block quotes is
* consistent.
* Indent here is the `>` (greater than) marker and the spaces before content.
* You can use this rule to check markdown code style.
*
* ## API
*
* The following options (default: `'consistent'`) are accepted:
* ### `unified().use(remarkLintBlockquoteIndentation[, options])`
*
* Warn when block quotes are indented too much or too little.
*
* ###### Parameters
*
* * `options` ([`Options`][api-options], default: `'consistent'`)
* — either a preferred indent or whether to detect the first style
* and warn for further differences
*
* ###### Returns
*
* * `number` (example: `2`)
* — preferred indent of `>` and spaces before content
* * `'consistent'`
* — detect the first used style and warn when further block quotes differ
* Transform ([`Transformer` from `unified`][github-unified-transformer]).
*
* ### `Options`
*
* Configuration (TypeScript type).
*
* ###### Type
*
* ```ts
* type Options = number | 'consistent'
* ```
*
* ## Recommendation
*
Expand All @@ -34,10 +57,11 @@
*
* Due to this, it’s recommended to configure this rule with `2`.
*
* [api-options]: #options
* [api-remark-lint-blockquote-indentation]: #unifieduseremarklintblockquoteindentation-options
* [github-unified-transformer]: https://github.com/unifiedjs/unified#transformer
*
* @module blockquote-indentation
* @summary
* remark-lint rule to warn when block quotes are indented too much or
* too little.
* @author Titus Wormer
* @copyright 2015 Titus Wormer
* @license MIT
Expand Down
8 changes: 2 additions & 6 deletions packages/remark-lint-blockquote-indentation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,15 @@
"remark-lint-rule",
"rule"
],
"repository": {
"type": "git",
"url": "https://github.com/remarkjs/remark-lint",
"directory": "packages/remark-lint-blockquote-indentation"
},
"repository": "https://github.com/remarkjs/remark-lint/tree/main/packages/remark-lint-blockquote-indentation",
"bugs": "https://github.com/remarkjs/remark-lint/issues",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/unified"
},
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"contributors": [
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
"Titus Wormer <tituswormer@gmail.com>"
],
"sideEffects": false,
"type": "module",
Expand Down
Loading

0 comments on commit 547188e

Please sign in to comment.