Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
node-version: 22

- name: Install dependencies
run: npm install
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
node-version: 22

- name: Install dependencies
run: npm install
Expand Down
80 changes: 60 additions & 20 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ const config = {
projectName: "documentation", // Usually your repo name.

onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
markdown: {
hooks: {
onBrokenMarkdownLinks: "warn",
},
},

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
Expand Down Expand Up @@ -82,7 +86,10 @@ const config = {
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["computed-form-fields/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -120,7 +127,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["conditional-form-fields/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -158,7 +168,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["field-validators/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -196,7 +209,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["network-status/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -234,7 +250,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["mock-api/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -272,7 +291,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["on-device-storage/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -310,7 +332,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["multistep-form/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -348,7 +373,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["server-sync/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -386,7 +414,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["react-query/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -424,7 +455,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["persisted-form/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -462,7 +496,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["simple-table/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -500,7 +537,10 @@ ${content}`,
"https://raw.githubusercontent.com/NMFS-RADFish/boilerplate/main/examples/",
outDir: "docs/developer-documentation/examples-and-templates/examples/", // the base directory to output to.
documents: ["form-structure/README.md"], // the file to download
modifyContent(filename, content) {
modifyContent(
/** @type {string} */ filename,
/** @type {string} */ content
) {
return {
filename: readmeToNamedMd(filename),
content: `---
Expand Down Expand Up @@ -571,18 +611,18 @@ ${content}`,
line: "diff-add",
block: {
start: "diff-add-start",
end: "diff-add-end"
}
end: "diff-add-end",
},
},
{
className: "code-block-diff-remove-line",
line: "diff-remove",
block: {
start: "diff-remove-start",
end: "diff-remove-end"
}
}
]
end: "diff-remove-end",
},
},
],
},
}),
};
Expand All @@ -592,6 +632,6 @@ export default config;
// This function path stub to a README.md file
// and returns the .md renamed as the parent folder.
// eg. "network-status/README.md" --> "network-status.md"
function readmeToNamedMd(filename) {
function readmeToNamedMd(/** @type {string} */ filename) {
return filename.split("/")[0].concat(".md");
}
Loading