Skip to content

Commit

Permalink
Rebased + CL tweaks + optional tooling
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Nov 8, 2023
1 parent 8cefe19 commit 29bfefb
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 17 deletions.
10 changes: 10 additions & 0 deletions .markdown-link-check.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"ignorePatterns": [
{
"pattern": "^http://localhost"
}
],
"timeout": "3s",
"retryOn429": true,
"aliveStatusCodes": [200, 206]
}
5 changes: 5 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.editorconfig
.gitignore
.nvmrc
.prettierignore
.s3deploy.yml
6 changes: 3 additions & 3 deletions .prettierrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"semi": true,
"singleQuote": true,
"tabWidth": 4
"proseWrap": "always",
"semi": true,
"singleQuote": true
}
10 changes: 3 additions & 7 deletions .vscode/cspell.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
// For settings, see https://www.streetsidesoftware.com/vscode-spell-checker/docs/configuration/
{
"version": "0.2",
"caseSensitive": true,
"words": [
"Docsy",
"shortcode",
"shortcodes"
]
"version": "0.2",
"caseSensitive": true,
"words": ["Docsy", "shortcode", "shortcodes"]
}
11 changes: 7 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ notes][releases].
Useful links:

- [Releases][] & [tags][]. Jump to the [latest][] release.
- [23Q3][] milestone
- [23Q4][] milestone

## [0.8.0][0.x.y] - next major release (unpublished yet)

Expand All @@ -25,17 +25,20 @@ For the full list of this release's changes, see the [release notes][0.x.y].

## [0.7.2][]

For the full list of this release's changes, see the [release notes][0.7.2]. We
mention one noteworthy change here:
For the full list of this release's changes, see the [0.7.2 release
notes][0.7.2]. We mention one noteworthy change here:

- **Algolia**
- [#1651] DocSearch fixed for mobile and for sites with two search boxes (in
the top and left navs).
- [#1662] DocSearch is supported by Docsy through site config.
- For details, see [Algolia DocSearch].
- **Tabpane** shortcode: some improvements, with more to come; for details, see
[#1641].

[#1651]: https://github.com/google/docsy/pull/1651
[#1662]: https://github.com/google/docsy/pull/1662
[#1641]: https://github.com/google/docsy/issues/1641
[Algolia DocSearch]:
https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch

Expand Down Expand Up @@ -296,7 +299,7 @@ For the full list of this release's changes, see the [release notes][0.x.y].
[0.3.0]: https://github.com/google/docsy/releases/v0.3.0
[0.2.0]: https://github.com/google/docsy/releases/v0.2.0
[0.x.y]: #changelog
[23q3]: https://github.com/google/docsy/milestone/8
[23q4]: https://github.com/google/docsy/milestone/9
[hugo modules]: https://gohugo.io/hugo-modules/
[latest]: https://github.com/google/docsy/releases/latest
[releases]: https://github.com/google/docsy/releases
Expand Down
11 changes: 8 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,35 @@
"license": "Apache-2.0",
"scripts": {
"_cd:docs": "cd userguide &&",
"_check:format": "npx prettier --check .??* *.md",
"build:preview": "npm run cd:docs build:preview",
"build:production": "npm run cd:docs build:production",
"build": "npm run cd:docs build",
"cd:docs": "npm run _cd:docs -- npm run",
"check:format": "npm run _check:format || (echo '[help] Run: npm run fix:format'; exit 1)",
"check:links--md": "npx markdown-link-check --config .markdown-link-check.json *.md",
"check:links:all": "npm run cd:docs check:links:all",
"check:links": "npm run cd:docs check:links",
"docs-install": "npm run _cd:docs -- npm install",
"fix:format": "npm run _check:format -- --write",
"get:submodule": "set -x && git submodule update --init ${DEPTH:- --depth 1}",
"serve": "npm run cd:docs serve",
"test": "npm run cd:docs test",
"update:pkg:hugo": "npm install --save-exact -D hugo-extended@latest",
"update:pkg:dep": "npm install --save-exact @fortawesome/fontawesome-free@latest bootstrap@latest"
},
"spelling": "cSpell:ignore docsy hugo fortawesome fontawesome userguide ",
"prettier": {
"proseWrap": "always"
},
"dependencies": {
"@fortawesome/fontawesome-free": "6.4.0",
"bootstrap": "5.2.3"
},
"devDependencies": {
"hugo-extended": "0.120.3"
},
"optionalDependencies": {
"markdown-link-check": "^3.11.2",
"prettier": "^3.0.3"
},
"engines": {
"node": ">=20"
}
Expand Down

0 comments on commit 29bfefb

Please sign in to comment.