Skip to content

Commit 231a9b1

Browse files
committed
chore(docs): add Prettier config (and ignore) for docs
1 parent f5dcfb9 commit 231a9b1

4 files changed

Lines changed: 36 additions & 23 deletions

File tree

package-lock.json

Lines changed: 18 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/docs/.prettierignore

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Docs
2-
# TODO: Format handwritten docs but not api reference docs
3-
docs/*
4-
docs/reference
1+
# Generated API reference docs
2+
docs/reference/
53

6-
# misc
7-
node_modules/*
4+
# Build artifacts
5+
build/
6+
.docusaurus/
7+
node_modules/
8+
9+
# Auto-generated
810
CHANGELOG.md

packages/docs/.prettierrc.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"singleQuote": true,
3+
"bracketSameLine": true,
4+
"proseWrap": "preserve"
5+
}

packages/docs/package.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212
"clear": "docusaurus clear",
1313
"serve": "docusaurus serve",
1414
"write-translations": "docusaurus write-translations",
15-
"write-heading-ids": "docusaurus write-heading-ids"
15+
"write-heading-ids": "docusaurus write-heading-ids",
16+
"format": "prettier --write .",
17+
"format:check": "prettier --check ."
1618
},
1719
"dependencies": {
1820
"@docusaurus/core": "3.9.2",
@@ -30,7 +32,8 @@
3032
"@docsearch/core": "^4.5.2",
3133
"@docusaurus/module-type-aliases": "3.9.2",
3234
"@docusaurus/types": "3.9.2",
33-
"gh-pages": "^6.3.0"
35+
"gh-pages": "^6.3.0",
36+
"prettier": "^3.8.1"
3437
},
3538
"browserslist": {
3639
"production": [

0 commit comments

Comments
 (0)