@patternfly/documentation-framework 6.0.0-alpha.26 → 6.0.0-alpha.27
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 +11 -0
- package/package.json +7 -7
- package/scripts/md/parseMD.js +30 -31
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,17 @@
|
|
|
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
|
+
# 6.0.0-alpha.27 (2024-05-14)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* full page demos, typescript compliation still turned off ([#4022](https://github.com/patternfly/patternfly-org/issues/4022)) ([1fea420](https://github.com/patternfly/patternfly-org/commit/1fea42035c875a36c45522dcd3f69176c35c88a7))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
# 6.0.0-alpha.26 (2024-05-14)
|
|
7
18
|
|
|
8
19
|
**Note:** Version bump only for package @patternfly/documentation-framework
|
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": "6.0.0-alpha.
|
|
4
|
+
"version": "6.0.0-alpha.27",
|
|
5
5
|
"author": "Red Hat",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"private": false,
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"@babel/preset-env": "^7.24.3",
|
|
14
14
|
"@babel/preset-react": "^7.24.1",
|
|
15
15
|
"@mdx-js/util": "1.6.16",
|
|
16
|
-
"@patternfly/ast-helpers": "^1.4.0-alpha.
|
|
16
|
+
"@patternfly/ast-helpers": "^1.4.0-alpha.16",
|
|
17
17
|
"@reach/router": "npm:@gatsbyjs/reach-router@1.3.9",
|
|
18
18
|
"autoprefixer": "9.8.6",
|
|
19
19
|
"babel-loader": "^9.1.3",
|
|
@@ -73,12 +73,12 @@
|
|
|
73
73
|
"webpack-merge": "5.8.0"
|
|
74
74
|
},
|
|
75
75
|
"peerDependencies": {
|
|
76
|
-
"@patternfly/patternfly": "6.0.0-alpha.
|
|
77
|
-
"@patternfly/react-code-editor": "6.0.0-alpha.
|
|
78
|
-
"@patternfly/react-core": "6.0.0-alpha.
|
|
79
|
-
"@patternfly/react-table": "6.0.0-alpha.
|
|
76
|
+
"@patternfly/patternfly": "6.0.0-alpha.117",
|
|
77
|
+
"@patternfly/react-code-editor": "6.0.0-alpha.56",
|
|
78
|
+
"@patternfly/react-core": "6.0.0-alpha.56",
|
|
79
|
+
"@patternfly/react-table": "6.0.0-alpha.56",
|
|
80
80
|
"react": "^17.0.0 || ^18.0.0",
|
|
81
81
|
"react-dom": "^17.0.0 || ^18.0.0"
|
|
82
82
|
},
|
|
83
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "cececdbb73ce156008462a6778bdf55123278f53"
|
|
84
84
|
}
|
package/scripts/md/parseMD.js
CHANGED
|
@@ -8,7 +8,7 @@ const vfileReport = require('vfile-reporter');
|
|
|
8
8
|
const yaml = require('js-yaml'); // https://github.com/nodeca/js-yaml
|
|
9
9
|
const chokidar = require('chokidar');
|
|
10
10
|
const { globSync } = require('glob');
|
|
11
|
-
|
|
11
|
+
const { typecheck } = require('./typecheck');
|
|
12
12
|
const { makeSlug } = require('../../helpers/slugger');
|
|
13
13
|
const { liveCodeTypes } = require('../../helpers/liveCodeTypes');
|
|
14
14
|
const { tsDocgen } = require('../tsDocgen');
|
|
@@ -204,36 +204,35 @@ function toReactComponent(mdFilePath, source, buildMode) {
|
|
|
204
204
|
&& node.tagName === 'Example'
|
|
205
205
|
&& liveCodeTypes.includes(node.properties.lang)
|
|
206
206
|
&& !node.properties.noLive;
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
// });
|
|
207
|
+
visit(tree, isExample, node => {
|
|
208
|
+
if (node.properties.isFullscreen) {
|
|
209
|
+
pageData.fullscreenExamples = pageData.fullscreenExamples || [];
|
|
210
|
+
pageData.fullscreenExamples.push(node.title);
|
|
211
|
+
}
|
|
212
|
+
else {
|
|
213
|
+
pageData.examples = pageData.examples || [];
|
|
214
|
+
pageData.examples.push(node.title);
|
|
215
|
+
}
|
|
216
|
+
// Typecheck TS examples
|
|
217
|
+
// if (node.properties.lang === 'ts') {
|
|
218
|
+
// const typerrors = typecheck(
|
|
219
|
+
// path.join(pageData.id, node.title + '.tsx'), // Needs to be unique per-example
|
|
220
|
+
// node.properties.code
|
|
221
|
+
// );
|
|
222
|
+
// typerrors.forEach(({ line, character, message }) => {
|
|
223
|
+
// line = node.position.start.line + line + 1;
|
|
224
|
+
// const column = character;
|
|
225
|
+
// if (buildMode === 'start') {
|
|
226
|
+
// // Don't fail to start over types
|
|
227
|
+
// file.message(`\u001b[31m THIS WILL FAIL THE BUILD\u001b[0m\n ${message}`, { line, column });
|
|
228
|
+
// } else {
|
|
229
|
+
// console.log('\u001b[31m');
|
|
230
|
+
// file.fail(`\n ${message}\n`, { line, column });
|
|
231
|
+
// console.log('\u001b[0m');
|
|
232
|
+
// }
|
|
233
|
+
// });
|
|
234
|
+
// }
|
|
235
|
+
});
|
|
237
236
|
})
|
|
238
237
|
// Add custom PatternFly doc design things
|
|
239
238
|
.use(require('./anchor-header'), toc => {
|