@patternfly/documentation-framework 5.7.0 → 5.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/package.json +3 -3
- package/scripts/md/parseMD.js +2 -0
- package/templates/mdx.js +6 -0
- package/versions.json +6 -3
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,25 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## 5.8.1 (2024-03-25)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @patternfly/documentation-framework
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# 5.8.0 (2024-03-20)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **templates:** add templates package to versions.json ([#3902](https://github.com/patternfly/patternfly-org/issues/3902)) ([c7c727c](https://github.com/patternfly/patternfly-org/commit/c7c727c717d5cc3c031f4f3c52070ffc6164e5d6))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
6
25
|
# 5.7.0 (2024-03-19)
|
|
7
26
|
|
|
8
27
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@patternfly/documentation-framework",
|
|
3
3
|
"description": "A framework to build documentation for PatternFly.",
|
|
4
|
-
"version": "5.
|
|
4
|
+
"version": "5.8.1",
|
|
5
5
|
"author": "Red Hat",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"private": false,
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@babel/plugin-transform-react-jsx": "7.17.12",
|
|
18
18
|
"@babel/preset-env": "7.18.2",
|
|
19
19
|
"@mdx-js/util": "1.6.16",
|
|
20
|
-
"@patternfly/ast-helpers": "^1.
|
|
20
|
+
"@patternfly/ast-helpers": "^1.8.1",
|
|
21
21
|
"@reach/router": "npm:@gatsbyjs/reach-router@1.3.9",
|
|
22
22
|
"autoprefixer": "9.8.6",
|
|
23
23
|
"babel-loader": "9.1.2",
|
|
@@ -84,5 +84,5 @@
|
|
|
84
84
|
"react": "^17.0.0 || ^18.0.0",
|
|
85
85
|
"react-dom": "^17.0.0 || ^18.0.0"
|
|
86
86
|
},
|
|
87
|
-
"gitHead": "
|
|
87
|
+
"gitHead": "a6a8fd24430027d2093352172d05e9076a918c76"
|
|
88
88
|
}
|
package/scripts/md/parseMD.js
CHANGED
|
@@ -105,6 +105,7 @@ function toReactComponent(mdFilePath, source, buildMode) {
|
|
|
105
105
|
section: frontmatter.section || '',
|
|
106
106
|
subsection: frontmatter.subsection || '',
|
|
107
107
|
deprecated: frontmatter.deprecated || false,
|
|
108
|
+
template: frontmatter.template || false,
|
|
108
109
|
beta: frontmatter.beta || false,
|
|
109
110
|
demo: frontmatter.demo || false,
|
|
110
111
|
newImplementationLink: frontmatter.newImplementationLink || false,
|
|
@@ -295,6 +296,7 @@ function sourceMDFile(file, source, buildMode) {
|
|
|
295
296
|
...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem }),
|
|
296
297
|
...(pageData.beta && { beta: pageData.beta }),
|
|
297
298
|
...(pageData.deprecated && { deprecated: pageData.deprecated }),
|
|
299
|
+
...(pageData.template && { template: pageData.template }),
|
|
298
300
|
...(pageData.demo && { demo: pageData.demo }),
|
|
299
301
|
...(pageData.sortValue && { sortValue: pageData.sortValue }),
|
|
300
302
|
...(pageData.subsectionSortValue && { subsectionSortValue: pageData.subsectionSortValue })
|
package/templates/mdx.js
CHANGED
|
@@ -23,6 +23,7 @@ const MDXChildTemplate = ({
|
|
|
23
23
|
optIn,
|
|
24
24
|
beta,
|
|
25
25
|
deprecated,
|
|
26
|
+
template,
|
|
26
27
|
newImplementationLink,
|
|
27
28
|
functionDocumentation = []
|
|
28
29
|
} = Component.getPageData();
|
|
@@ -84,6 +85,11 @@ const MDXChildTemplate = ({
|
|
|
84
85
|
{' '}To learn more about the process, visit our <Link to="/get-started/about#major-release-cadence">about page</Link>.
|
|
85
86
|
</InlineAlert>
|
|
86
87
|
)}
|
|
88
|
+
{(template || source === 'react-template') && (
|
|
89
|
+
<InlineAlert title="Templates" variant="info">
|
|
90
|
+
{`This page showcases templates for the ${id.toLowerCase()} component. A template combines a component with logic that supports a specific use case, with a streamlined API that offers additional, limited customization.`}
|
|
91
|
+
</InlineAlert>
|
|
92
|
+
)}
|
|
87
93
|
</React.Fragment>
|
|
88
94
|
);
|
|
89
95
|
// Create dynamic component for @reach/router
|
package/versions.json
CHANGED
|
@@ -21,7 +21,8 @@
|
|
|
21
21
|
"@patternfly/react-topology": "5.2.1",
|
|
22
22
|
"@patternfly/react-user-feedback": "5.0.0",
|
|
23
23
|
"@patternfly/react-virtualized-extension": "5.0.0",
|
|
24
|
-
"@patternfly/quickstarts": "5.0.0"
|
|
24
|
+
"@patternfly/quickstarts": "5.0.0",
|
|
25
|
+
"@patternfly/react-templates": "^1.0.0-alpha.0"
|
|
25
26
|
}
|
|
26
27
|
},
|
|
27
28
|
{
|
|
@@ -45,7 +46,8 @@
|
|
|
45
46
|
"@patternfly/react-topology": "5.2.1",
|
|
46
47
|
"@patternfly/react-user-feedback": "5.0.0",
|
|
47
48
|
"@patternfly/react-virtualized-extension": "5.0.0",
|
|
48
|
-
"@patternfly/quickstarts": "5.0.0"
|
|
49
|
+
"@patternfly/quickstarts": "5.0.0",
|
|
50
|
+
"@patternfly/react-templates": "^1.0.0-alpha.0"
|
|
49
51
|
}
|
|
50
52
|
},
|
|
51
53
|
{
|
|
@@ -69,7 +71,8 @@
|
|
|
69
71
|
"@patternfly/react-topology": "5.2.1",
|
|
70
72
|
"@patternfly/react-user-feedback": "5.0.0",
|
|
71
73
|
"@patternfly/react-virtualized-extension": "5.0.0",
|
|
72
|
-
"@patternfly/quickstarts": "5.0.0"
|
|
74
|
+
"@patternfly/quickstarts": "5.0.0",
|
|
75
|
+
"@patternfly/react-templates": "^1.0.0-alpha.0"
|
|
73
76
|
}
|
|
74
77
|
},{
|
|
75
78
|
"name": "5.1.0",
|