Skip to content

Commit 0f6386f

Browse files
Merge pull request #2023 from markscott-ms/fix/docusaurus-4-compat
chore(shared,docs,cli): relocate deprecated docusaurs configuration property
2 parents 138b9ac + 1c4203b commit 0f6386f

6 files changed

Lines changed: 25 additions & 11 deletions

File tree

cli/test_fixtures/getting-started/STEP-2/website/docusaurus.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports = {
55
url: 'http://localhost',
66
baseUrl: '/',
77
onBrokenLinks: 'throw',
8-
onBrokenMarkdownLinks: 'warn',
98
favicon: 'img/favicon.ico',
109
organizationName: 'my-org',
1110
projectName: 'calm-docs',
@@ -24,7 +23,10 @@ module.exports = {
2423
'@docusaurus/theme-mermaid',
2524
],
2625
markdown: {
27-
mermaid: true
26+
mermaid: true,
27+
hooks: {
28+
onBrokenMarkdownLinks: 'warn'
29+
}
2830
},
2931
stylesheets: [
3032
'/css/custom.css'

cli/test_fixtures/getting-started/STEP-3/website/docusaurus.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports = {
55
url: 'http://localhost',
66
baseUrl: '/',
77
onBrokenLinks: 'throw',
8-
onBrokenMarkdownLinks: 'warn',
98
favicon: 'img/favicon.ico',
109
organizationName: 'my-org',
1110
projectName: 'calm-docs',
@@ -24,7 +23,10 @@ module.exports = {
2423
'@docusaurus/theme-mermaid',
2524
],
2625
markdown: {
27-
mermaid: true
26+
mermaid: true,
27+
hooks: {
28+
onBrokenMarkdownLinks: 'warn'
29+
}
2830
},
2931
stylesheets: [
3032
'/css/custom.css'

docs/docusaurus.config.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ const config = {
2424
projectName: 'architecture-as-code', // Usually your repo name.
2525

2626
onBrokenLinks: 'throw',
27-
onBrokenMarkdownLinks: 'warn',
27+
markdown: {
28+
hooks: {
29+
onBrokenMarkdownLinks: 'warn'
30+
}
31+
},
2832

2933
// Even if you don't use internationalization, you can use this field to set
3034
// useful metadata like html lang. For example, if your site is Chinese, you

shared/src/docify/template-bundles/docusaurus/docusaurus.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports = {
55
url: 'http://localhost',
66
baseUrl: '/',
77
onBrokenLinks: 'throw',
8-
onBrokenMarkdownLinks: 'warn',
98
favicon: 'img/favicon.ico',
109
organizationName: 'my-org',
1110
projectName: 'calm-docs',
@@ -24,7 +23,10 @@ module.exports = {
2423
'@docusaurus/theme-mermaid',
2524
],
2625
markdown: {
27-
mermaid: true
26+
mermaid: true,
27+
hooks: {
28+
onBrokenMarkdownLinks: 'warn'
29+
}
2830
},
2931
stylesheets: [
3032
'/css/custom.css'

shared/test_fixtures/docify/workshop/expected-output/non-secure/docusaurus.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports = {
55
url: 'http://localhost',
66
baseUrl: '/',
77
onBrokenLinks: 'throw',
8-
onBrokenMarkdownLinks: 'warn',
98
favicon: 'img/favicon.ico',
109
organizationName: 'my-org',
1110
projectName: 'calm-docs',
@@ -24,7 +23,10 @@ module.exports = {
2423
'@docusaurus/theme-mermaid',
2524
],
2625
markdown: {
27-
mermaid: true
26+
mermaid: true,
27+
hooks: {
28+
onBrokenMarkdownLinks: 'warn'
29+
}
2830
},
2931
stylesheets: [
3032
'/css/custom.css'

shared/test_fixtures/docify/workshop/expected-output/secure/docusaurus.config.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ module.exports = {
55
url: 'http://localhost',
66
baseUrl: '/',
77
onBrokenLinks: 'throw',
8-
onBrokenMarkdownLinks: 'warn',
98
favicon: 'img/favicon.ico',
109
organizationName: 'my-org',
1110
projectName: 'calm-docs',
@@ -24,7 +23,10 @@ module.exports = {
2423
'@docusaurus/theme-mermaid',
2524
],
2625
markdown: {
27-
mermaid: true
26+
mermaid: true,
27+
hooks: {
28+
onBrokenMarkdownLinks: 'warn'
29+
}
2830
},
2931
stylesheets: [
3032
'/css/custom.css'

0 commit comments

Comments
 (0)