@patternfly/patternfly-doc-core 1.0.0

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.
Files changed (111) hide show
  1. package/.astro/collections/dir.schema.json +28 -0
  2. package/.astro/collections/textContent.schema.json +28 -0
  3. package/.astro/content-assets.mjs +1 -0
  4. package/.astro/content-modules.mjs +1 -0
  5. package/.astro/content.d.ts +171 -0
  6. package/.astro/types.d.ts +2 -0
  7. package/.github/workflows/build.yml +61 -0
  8. package/.history/package_20250227163130.json +97 -0
  9. package/.history/package_20250227163527.json +97 -0
  10. package/.history/package_20250227163646.json +97 -0
  11. package/.history/package_20250227163651.json +97 -0
  12. package/.history/package_20250227163654.json +97 -0
  13. package/.history/package_20250227163657.json +97 -0
  14. package/.history/package_20250227163659.json +97 -0
  15. package/.history/package_20250227164608.json +97 -0
  16. package/.history/package_20250227164611.json +97 -0
  17. package/.history/package_20250227164616.json +98 -0
  18. package/.vscode/extensions.json +4 -0
  19. package/.vscode/launch.json +11 -0
  20. package/README.md +49 -0
  21. package/astro.config.mjs +18 -0
  22. package/babel.config.cjs +4 -0
  23. package/cli/cli.ts +81 -0
  24. package/cli/createCollectionContent.ts +31 -0
  25. package/cli/createConfigFile.ts +36 -0
  26. package/cli/getConfig.ts +28 -0
  27. package/cli/setFsRootDir.ts +29 -0
  28. package/cli/templates/package.json +19 -0
  29. package/cli/templates/pf-docs.config.mjs +20 -0
  30. package/cli/testData/good.config.js +12 -0
  31. package/cli/tsconfig.json +9 -0
  32. package/cli/updatePackageFile.ts +55 -0
  33. package/dist/PF-HorizontalLogo-Color.svg +29 -0
  34. package/dist/PF-HorizontalLogo-Reverse.svg +28 -0
  35. package/dist/_astro/ClientRouter.astro_astro_type_script_index_0_lang.BScVxmeO.js +1 -0
  36. package/dist/_astro/Navigation.BoL0fVlO.js +1 -0
  37. package/dist/_astro/PageContext.CGSBAxAd.js +9 -0
  38. package/dist/_astro/PageToggle.jHn9PsTr.js +1 -0
  39. package/dist/_astro/RedHatDisplayVF-Italic.CRpusWc8.woff2 +0 -0
  40. package/dist/_astro/RedHatDisplayVF.CYDHf1NI.woff2 +0 -0
  41. package/dist/_astro/RedHatMonoVF-Italic.DGQo2ogW.woff2 +0 -0
  42. package/dist/_astro/RedHatMonoVF.C4fMH6Vz.woff2 +0 -0
  43. package/dist/_astro/RedHatTextVF-Italic.Dkj_WqbA.woff2 +0 -0
  44. package/dist/_astro/RedHatTextVF.wYvZ7prR.woff2 +0 -0
  45. package/dist/_astro/Toolbar.BI0orElX.js +1 -0
  46. package/dist/_astro/_id_.DZfGTTvw.css +1 -0
  47. package/dist/_astro/_id_.EhyPoRav.css +1 -0
  48. package/dist/_astro/client.DBe4QnD_.js +1 -0
  49. package/dist/_astro/divider.DrQDtXS2.js +1 -0
  50. package/dist/_astro/fa-solid-900.DguXoeIz.woff2 +0 -0
  51. package/dist/_astro/index.IDjx8w0N.js +32 -0
  52. package/dist/_astro/navStore.br_igkhP.js +1 -0
  53. package/dist/_astro/pf-v6-pficon.Dy6oiu9u.woff2 +0 -0
  54. package/dist/avatarImg.svg +18 -0
  55. package/dist/avatarImgDark.svg +16 -0
  56. package/dist/cli/cli.js +57 -0
  57. package/dist/cli/createCollectionContent.js +26 -0
  58. package/dist/cli/createConfigFile.js +22 -0
  59. package/dist/cli/getConfig.js +14 -0
  60. package/dist/cli/setFsRootDir.js +20 -0
  61. package/dist/cli/templates/pf-docs.config.mjs +20 -0
  62. package/dist/cli/tsconfig.tsbuildinfo +1 -0
  63. package/dist/cli/updatePackageFile.js +35 -0
  64. package/dist/content/typography/line-height.png +0 -0
  65. package/dist/design-foundations/typography/index.html +193 -0
  66. package/dist/design-foundations/usage-and-behavior/index.html +342 -0
  67. package/dist/favicon.svg +9 -0
  68. package/dist/get-started/contribute/index.html +89 -0
  69. package/dist/index.html +42 -0
  70. package/eslint.config.mjs +131 -0
  71. package/jest.config.ts +27 -0
  72. package/package.json +98 -0
  73. package/public/PF-HorizontalLogo-Color.svg +29 -0
  74. package/public/PF-HorizontalLogo-Reverse.svg +28 -0
  75. package/public/avatarImg.svg +18 -0
  76. package/public/avatarImgDark.svg +16 -0
  77. package/public/content/typography/line-height.png +0 -0
  78. package/public/favicon.svg +9 -0
  79. package/release.config.mjs +16 -0
  80. package/src/__mocks__/styleMock.ts +2 -0
  81. package/src/components/Breadcrumbs.astro +10 -0
  82. package/src/components/KebabDropdownItems.astro +14 -0
  83. package/src/components/KebabDropdownItems.tsx +15 -0
  84. package/src/components/Masthead.astro +30 -0
  85. package/src/components/NavEntry.tsx +26 -0
  86. package/src/components/NavSection.tsx +38 -0
  87. package/src/components/Navigation.astro +13 -0
  88. package/src/components/Navigation.tsx +58 -0
  89. package/src/components/Page.astro +19 -0
  90. package/src/components/PageToggle.tsx +47 -0
  91. package/src/components/Toolbar.astro +5 -0
  92. package/src/components/Toolbar.tsx +173 -0
  93. package/src/components/UserDropdownItems.astro +9 -0
  94. package/src/components/UserDropdownItems.tsx +10 -0
  95. package/src/content.config.ts +36 -0
  96. package/src/content.ts +1 -0
  97. package/src/env.d.ts +1 -0
  98. package/src/layouts/Main.astro +26 -0
  99. package/src/pages/[section]/[...id].astro +31 -0
  100. package/src/pages/index.astro +17 -0
  101. package/src/stores/navStore.ts +3 -0
  102. package/src/styles/global.scss +1 -0
  103. package/src/utils/capitalize.ts +3 -0
  104. package/src/utils/index.ts +1 -0
  105. package/test.setup.ts +2 -0
  106. package/textContent/contribute.md +71 -0
  107. package/textContent/typography.md +95 -0
  108. package/textContent/usage-and-behavior.md +139 -0
  109. package/tsconfig.jest.json +8 -0
  110. package/tsconfig.json +14 -0
  111. package/tsconfig.vitest.json +6 -0
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "@pattternfly/patternfly-doc-core",
3
+ "type": "module",
4
+ "version": "0.0.0-development",
5
+ "publishConfig": {
6
+ "access": "public"
7
+ },
8
+ "scripts": {
9
+ "dev": "astro dev",
10
+ "start": "astro dev",
11
+ "build": "astro check && astro build",
12
+ "build:cli": "tsc --build ./cli/tsconfig.json",
13
+ "build:cli:watch": "tsc --build --watch ./cli/tsconfig.json",
14
+ "preview": "astro preview",
15
+ "astro": "astro",
16
+ "prettier": "prettier --write ./src",
17
+ "lint": "eslint . --cache --cache-strategy content",
18
+ "test": "jest",
19
+ "test:watch": "jest --watch",
20
+ "semantic-release": "semantic-release"
21
+ },
22
+ "main": "dist/cli/cli.js",
23
+ "bin": "./dist/cli/cli.js",
24
+ "prettier": {
25
+ "plugins": [
26
+ "prettier-plugin-astro"
27
+ ],
28
+ "overrides": [
29
+ {
30
+ "files": "*.astro",
31
+ "options": {
32
+ "parser": "astro"
33
+ }
34
+ }
35
+ ],
36
+ "semi": false,
37
+ "singleQuote": true,
38
+ "trailingComma": "all"
39
+ },
40
+ "dependencies": {
41
+ "@astrojs/check": "^0.9.4",
42
+ "@astrojs/react": "^4.1.5",
43
+ "@nanostores/react": "^0.8.0",
44
+ "@patternfly/patternfly": "^6.0.0",
45
+ "@patternfly/react-core": "^6.0.0",
46
+ "@types/react": "^18.3.12",
47
+ "@types/react-dom": "^18.3.1",
48
+ "astro": "^5.1.7",
49
+ "change-case": "5.4.4",
50
+ "glob": "^11.0.1",
51
+ "nanostores": "^0.11.3",
52
+ "react": "^18.3.1",
53
+ "react-dom": "^18.3.1",
54
+ "sass": "^1.81.0",
55
+ "typescript": "^5.6.3"
56
+ },
57
+ "devDependencies": {
58
+ "@babel/plugin-transform-modules-commonjs": "^7.26.3",
59
+ "@babel/preset-react": "^7.26.3",
60
+ "@babel/preset-typescript": "^7.26.0",
61
+ "@eslint/js": "^9.16.0",
62
+ "@semantic-release/git": "^10.0.1",
63
+ "@testing-library/jest-dom": "^6.6.3",
64
+ "@testing-library/react": "^16.1.0",
65
+ "@testing-library/user-event": "^14.5.2",
66
+ "@types/jest": "^29.5.14",
67
+ "@types/node": "^22.9.1",
68
+ "@typescript-eslint/eslint-plugin": "^8.17.0",
69
+ "@typescript-eslint/parser": "^8.17.0",
70
+ "babel-jest": "^29.7.0",
71
+ "commander": "^13.1.0",
72
+ "cz-conventional-changelog": "^3.3.0",
73
+ "eslint": "^9.16.0",
74
+ "eslint-config-prettier": "^9.1.0",
75
+ "eslint-plugin-astro": "^1.3.1",
76
+ "eslint-plugin-markdown": "^5.1.0",
77
+ "eslint-plugin-prettier": "^5.2.1",
78
+ "eslint-plugin-react": "^7.37.2",
79
+ "eslint-plugin-react-compiler": "^19.0.0-beta-df7b47d-20241124",
80
+ "eslint-plugin-react-hooks": "^5.1.0",
81
+ "globals": "^15.12.0",
82
+ "jest": "^29.7.0",
83
+ "jest-environment-jsdom": "^29.7.0",
84
+ "jsdom": "^25.0.1",
85
+ "prettier": "^3.4.2",
86
+ "prettier-plugin-astro": "^0.14.1",
87
+ "semantic-release": "^24.2.3",
88
+ "ts-jest": "^29.2.5",
89
+ "ts-node": "^10.9.2",
90
+ "typescript-eslint": "^8.15.0"
91
+ },
92
+ "config": {
93
+ "commitizen": {
94
+ "path": "./node_modules/cz-conventional-changelog"
95
+ }
96
+ }
97
+ }
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "@paernfly/patternfly-doc-core",
3
+ "type": "module",
4
+ "version": "0.0.0-development",
5
+ "publishConfig": {
6
+ "access": "public"
7
+ },
8
+ "scripts": {
9
+ "dev": "astro dev",
10
+ "start": "astro dev",
11
+ "build": "astro check && astro build",
12
+ "build:cli": "tsc --build ./cli/tsconfig.json",
13
+ "build:cli:watch": "tsc --build --watch ./cli/tsconfig.json",
14
+ "preview": "astro preview",
15
+ "astro": "astro",
16
+ "prettier": "prettier --write ./src",
17
+ "lint": "eslint . --cache --cache-strategy content",
18
+ "test": "jest",
19
+ "test:watch": "jest --watch",
20
+ "semantic-release": "semantic-release"
21
+ },
22
+ "main": "dist/cli/cli.js",
23
+ "bin": "./dist/cli/cli.js",
24
+ "prettier": {
25
+ "plugins": [
26
+ "prettier-plugin-astro"
27
+ ],
28
+ "overrides": [
29
+ {
30
+ "files": "*.astro",
31
+ "options": {
32
+ "parser": "astro"
33
+ }
34
+ }
35
+ ],
36
+ "semi": false,
37
+ "singleQuote": true,
38
+ "trailingComma": "all"
39
+ },
40
+ "dependencies": {
41
+ "@astrojs/check": "^0.9.4",
42
+ "@astrojs/react": "^4.1.5",
43
+ "@nanostores/react": "^0.8.0",
44
+ "@patternfly/patternfly": "^6.0.0",
45
+ "@patternfly/react-core": "^6.0.0",
46
+ "@types/react": "^18.3.12",
47
+ "@types/react-dom": "^18.3.1",
48
+ "astro": "^5.1.7",
49
+ "change-case": "5.4.4",
50
+ "glob": "^11.0.1",
51
+ "nanostores": "^0.11.3",
52
+ "react": "^18.3.1",
53
+ "react-dom": "^18.3.1",
54
+ "sass": "^1.81.0",
55
+ "typescript": "^5.6.3"
56
+ },
57
+ "devDependencies": {
58
+ "@babel/plugin-transform-modules-commonjs": "^7.26.3",
59
+ "@babel/preset-react": "^7.26.3",
60
+ "@babel/preset-typescript": "^7.26.0",
61
+ "@eslint/js": "^9.16.0",
62
+ "@semantic-release/git": "^10.0.1",
63
+ "@testing-library/jest-dom": "^6.6.3",
64
+ "@testing-library/react": "^16.1.0",
65
+ "@testing-library/user-event": "^14.5.2",
66
+ "@types/jest": "^29.5.14",
67
+ "@types/node": "^22.9.1",
68
+ "@typescript-eslint/eslint-plugin": "^8.17.0",
69
+ "@typescript-eslint/parser": "^8.17.0",
70
+ "babel-jest": "^29.7.0",
71
+ "commander": "^13.1.0",
72
+ "cz-conventional-changelog": "^3.3.0",
73
+ "eslint": "^9.16.0",
74
+ "eslint-config-prettier": "^9.1.0",
75
+ "eslint-plugin-astro": "^1.3.1",
76
+ "eslint-plugin-markdown": "^5.1.0",
77
+ "eslint-plugin-prettier": "^5.2.1",
78
+ "eslint-plugin-react": "^7.37.2",
79
+ "eslint-plugin-react-compiler": "^19.0.0-beta-df7b47d-20241124",
80
+ "eslint-plugin-react-hooks": "^5.1.0",
81
+ "globals": "^15.12.0",
82
+ "jest": "^29.7.0",
83
+ "jest-environment-jsdom": "^29.7.0",
84
+ "jsdom": "^25.0.1",
85
+ "prettier": "^3.4.2",
86
+ "prettier-plugin-astro": "^0.14.1",
87
+ "semantic-release": "^24.2.3",
88
+ "ts-jest": "^29.2.5",
89
+ "ts-node": "^10.9.2",
90
+ "typescript-eslint": "^8.15.0"
91
+ },
92
+ "config": {
93
+ "commitizen": {
94
+ "path": "./node_modules/cz-conventional-changelog"
95
+ }
96
+ }
97
+ }
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "@patternfly/patternfly-doc-core",
3
+ "type": "module",
4
+ "version": "0.0.0-development",
5
+ "publishConfig": {
6
+ "access": "public"
7
+ },
8
+ "scripts": {
9
+ "dev": "astro dev",
10
+ "start": "astro dev",
11
+ "build": "astro check && astro build",
12
+ "build:cli": "tsc --build ./cli/tsconfig.json",
13
+ "build:cli:watch": "tsc --build --watch ./cli/tsconfig.json",
14
+ "preview": "astro preview",
15
+ "astro": "astro",
16
+ "prettier": "prettier --write ./src",
17
+ "lint": "eslint . --cache --cache-strategy content",
18
+ "test": "jest",
19
+ "test:watch": "jest --watch",
20
+ "semantic-release": "semantic-release"
21
+ },
22
+ "main": "dist/cli/cli.js",
23
+ "bin": "./dist/cli/cli.js",
24
+ "prettier": {
25
+ "plugins": [
26
+ "prettier-plugin-astro"
27
+ ],
28
+ "overrides": [
29
+ {
30
+ "files": "*.astro",
31
+ "options": {
32
+ "parser": "astro"
33
+ }
34
+ }
35
+ ],
36
+ "semi": false,
37
+ "singleQuote": true,
38
+ "trailingComma": "all"
39
+ },
40
+ "dependencies": {
41
+ "@astrojs/check": "^0.9.4",
42
+ "@astrojs/react": "^4.1.5",
43
+ "@nanostores/react": "^0.8.0",
44
+ "@patternfly/patternfly": "^6.0.0",
45
+ "@patternfly/react-core": "^6.0.0",
46
+ "@types/react": "^18.3.12",
47
+ "@types/react-dom": "^18.3.1",
48
+ "astro": "^5.1.7",
49
+ "change-case": "5.4.4",
50
+ "glob": "^11.0.1",
51
+ "nanostores": "^0.11.3",
52
+ "react": "^18.3.1",
53
+ "react-dom": "^18.3.1",
54
+ "sass": "^1.81.0",
55
+ "typescript": "^5.6.3"
56
+ },
57
+ "devDependencies": {
58
+ "@babel/plugin-transform-modules-commonjs": "^7.26.3",
59
+ "@babel/preset-react": "^7.26.3",
60
+ "@babel/preset-typescript": "^7.26.0",
61
+ "@eslint/js": "^9.16.0",
62
+ "@semantic-release/git": "^10.0.1",
63
+ "@testing-library/jest-dom": "^6.6.3",
64
+ "@testing-library/react": "^16.1.0",
65
+ "@testing-library/user-event": "^14.5.2",
66
+ "@types/jest": "^29.5.14",
67
+ "@types/node": "^22.9.1",
68
+ "@typescript-eslint/eslint-plugin": "^8.17.0",
69
+ "@typescript-eslint/parser": "^8.17.0",
70
+ "babel-jest": "^29.7.0",
71
+ "commander": "^13.1.0",
72
+ "cz-conventional-changelog": "^3.3.0",
73
+ "eslint": "^9.16.0",
74
+ "eslint-config-prettier": "^9.1.0",
75
+ "eslint-plugin-astro": "^1.3.1",
76
+ "eslint-plugin-markdown": "^5.1.0",
77
+ "eslint-plugin-prettier": "^5.2.1",
78
+ "eslint-plugin-react": "^7.37.2",
79
+ "eslint-plugin-react-compiler": "^19.0.0-beta-df7b47d-20241124",
80
+ "eslint-plugin-react-hooks": "^5.1.0",
81
+ "globals": "^15.12.0",
82
+ "jest": "^29.7.0",
83
+ "jest-environment-jsdom": "^29.7.0",
84
+ "jsdom": "^25.0.1",
85
+ "prettier": "^3.4.2",
86
+ "prettier-plugin-astro": "^0.14.1",
87
+ "semantic-release": "^24.2.3",
88
+ "ts-jest": "^29.2.5",
89
+ "ts-node": "^10.9.2",
90
+ "typescript-eslint": "^8.15.0"
91
+ },
92
+ "config": {
93
+ "commitizen": {
94
+ "path": "./node_modules/cz-conventional-changelog"
95
+ }
96
+ }
97
+ }
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "@patternfly/patternfly-doc-core",
3
+ "type": "module",
4
+ "version": "1.",
5
+ "publishConfig": {
6
+ "access": "public"
7
+ },
8
+ "scripts": {
9
+ "dev": "astro dev",
10
+ "start": "astro dev",
11
+ "build": "astro check && astro build",
12
+ "build:cli": "tsc --build ./cli/tsconfig.json",
13
+ "build:cli:watch": "tsc --build --watch ./cli/tsconfig.json",
14
+ "preview": "astro preview",
15
+ "astro": "astro",
16
+ "prettier": "prettier --write ./src",
17
+ "lint": "eslint . --cache --cache-strategy content",
18
+ "test": "jest",
19
+ "test:watch": "jest --watch",
20
+ "semantic-release": "semantic-release"
21
+ },
22
+ "main": "dist/cli/cli.js",
23
+ "bin": "./dist/cli/cli.js",
24
+ "prettier": {
25
+ "plugins": [
26
+ "prettier-plugin-astro"
27
+ ],
28
+ "overrides": [
29
+ {
30
+ "files": "*.astro",
31
+ "options": {
32
+ "parser": "astro"
33
+ }
34
+ }
35
+ ],
36
+ "semi": false,
37
+ "singleQuote": true,
38
+ "trailingComma": "all"
39
+ },
40
+ "dependencies": {
41
+ "@astrojs/check": "^0.9.4",
42
+ "@astrojs/react": "^4.1.5",
43
+ "@nanostores/react": "^0.8.0",
44
+ "@patternfly/patternfly": "^6.0.0",
45
+ "@patternfly/react-core": "^6.0.0",
46
+ "@types/react": "^18.3.12",
47
+ "@types/react-dom": "^18.3.1",
48
+ "astro": "^5.1.7",
49
+ "change-case": "5.4.4",
50
+ "glob": "^11.0.1",
51
+ "nanostores": "^0.11.3",
52
+ "react": "^18.3.1",
53
+ "react-dom": "^18.3.1",
54
+ "sass": "^1.81.0",
55
+ "typescript": "^5.6.3"
56
+ },
57
+ "devDependencies": {
58
+ "@babel/plugin-transform-modules-commonjs": "^7.26.3",
59
+ "@babel/preset-react": "^7.26.3",
60
+ "@babel/preset-typescript": "^7.26.0",
61
+ "@eslint/js": "^9.16.0",
62
+ "@semantic-release/git": "^10.0.1",
63
+ "@testing-library/jest-dom": "^6.6.3",
64
+ "@testing-library/react": "^16.1.0",
65
+ "@testing-library/user-event": "^14.5.2",
66
+ "@types/jest": "^29.5.14",
67
+ "@types/node": "^22.9.1",
68
+ "@typescript-eslint/eslint-plugin": "^8.17.0",
69
+ "@typescript-eslint/parser": "^8.17.0",
70
+ "babel-jest": "^29.7.0",
71
+ "commander": "^13.1.0",
72
+ "cz-conventional-changelog": "^3.3.0",
73
+ "eslint": "^9.16.0",
74
+ "eslint-config-prettier": "^9.1.0",
75
+ "eslint-plugin-astro": "^1.3.1",
76
+ "eslint-plugin-markdown": "^5.1.0",
77
+ "eslint-plugin-prettier": "^5.2.1",
78
+ "eslint-plugin-react": "^7.37.2",
79
+ "eslint-plugin-react-compiler": "^19.0.0-beta-df7b47d-20241124",
80
+ "eslint-plugin-react-hooks": "^5.1.0",
81
+ "globals": "^15.12.0",
82
+ "jest": "^29.7.0",
83
+ "jest-environment-jsdom": "^29.7.0",
84
+ "jsdom": "^25.0.1",
85
+ "prettier": "^3.4.2",
86
+ "prettier-plugin-astro": "^0.14.1",
87
+ "semantic-release": "^24.2.3",
88
+ "ts-jest": "^29.2.5",
89
+ "ts-node": "^10.9.2",
90
+ "typescript-eslint": "^8.15.0"
91
+ },
92
+ "config": {
93
+ "commitizen": {
94
+ "path": "./node_modules/cz-conventional-changelog"
95
+ }
96
+ }
97
+ }
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "@patternfly/patternfly-doc-core",
3
+ "type": "module",
4
+ "version": "1.0.0",
5
+ "publishConfig": {
6
+ "access": "public"
7
+ },
8
+ "scripts": {
9
+ "dev": "astro dev",
10
+ "start": "astro dev",
11
+ "build": "astro check && astro build",
12
+ "build:cli": "tsc --build ./cli/tsconfig.json",
13
+ "build:cli:watch": "tsc --build --watch ./cli/tsconfig.json",
14
+ "preview": "astro preview",
15
+ "astro": "astro",
16
+ "prettier": "prettier --write ./src",
17
+ "lint": "eslint . --cache --cache-strategy content",
18
+ "test": "jest",
19
+ "test:watch": "jest --watch",
20
+ "semantic-release": "semantic-release"
21
+ },
22
+ "main": "dist/cli/cli.js",
23
+ "bin": "./dist/cli/cli.js",
24
+ "prettier": {
25
+ "plugins": [
26
+ "prettier-plugin-astro"
27
+ ],
28
+ "overrides": [
29
+ {
30
+ "files": "*.astro",
31
+ "options": {
32
+ "parser": "astro"
33
+ }
34
+ }
35
+ ],
36
+ "semi": false,
37
+ "singleQuote": true,
38
+ "trailingComma": "all"
39
+ },
40
+ "dependencies": {
41
+ "@astrojs/check": "^0.9.4",
42
+ "@astrojs/react": "^4.1.5",
43
+ "@nanostores/react": "^0.8.0",
44
+ "@patternfly/patternfly": "^6.0.0",
45
+ "@patternfly/react-core": "^6.0.0",
46
+ "@types/react": "^18.3.12",
47
+ "@types/react-dom": "^18.3.1",
48
+ "astro": "^5.1.7",
49
+ "change-case": "5.4.4",
50
+ "glob": "^11.0.1",
51
+ "nanostores": "^0.11.3",
52
+ "react": "^18.3.1",
53
+ "react-dom": "^18.3.1",
54
+ "sass": "^1.81.0",
55
+ "typescript": "^5.6.3"
56
+ },
57
+ "devDependencies": {
58
+ "@babel/plugin-transform-modules-commonjs": "^7.26.3",
59
+ "@babel/preset-react": "^7.26.3",
60
+ "@babel/preset-typescript": "^7.26.0",
61
+ "@eslint/js": "^9.16.0",
62
+ "@semantic-release/git": "^10.0.1",
63
+ "@testing-library/jest-dom": "^6.6.3",
64
+ "@testing-library/react": "^16.1.0",
65
+ "@testing-library/user-event": "^14.5.2",
66
+ "@types/jest": "^29.5.14",
67
+ "@types/node": "^22.9.1",
68
+ "@typescript-eslint/eslint-plugin": "^8.17.0",
69
+ "@typescript-eslint/parser": "^8.17.0",
70
+ "babel-jest": "^29.7.0",
71
+ "commander": "^13.1.0",
72
+ "cz-conventional-changelog": "^3.3.0",
73
+ "eslint": "^9.16.0",
74
+ "eslint-config-prettier": "^9.1.0",
75
+ "eslint-plugin-astro": "^1.3.1",
76
+ "eslint-plugin-markdown": "^5.1.0",
77
+ "eslint-plugin-prettier": "^5.2.1",
78
+ "eslint-plugin-react": "^7.37.2",
79
+ "eslint-plugin-react-compiler": "^19.0.0-beta-df7b47d-20241124",
80
+ "eslint-plugin-react-hooks": "^5.1.0",
81
+ "globals": "^15.12.0",
82
+ "jest": "^29.7.0",
83
+ "jest-environment-jsdom": "^29.7.0",
84
+ "jsdom": "^25.0.1",
85
+ "prettier": "^3.4.2",
86
+ "prettier-plugin-astro": "^0.14.1",
87
+ "semantic-release": "^24.2.3",
88
+ "ts-jest": "^29.2.5",
89
+ "ts-node": "^10.9.2",
90
+ "typescript-eslint": "^8.15.0"
91
+ },
92
+ "config": {
93
+ "commitizen": {
94
+ "path": "./node_modules/cz-conventional-changelog"
95
+ }
96
+ }
97
+ }
@@ -0,0 +1,98 @@
1
+ {
2
+ "name": "@patternfly/patternfly-doc-core",
3
+ "type": "module",
4
+ "version": "1.0.0",
5
+ "description": "PatternFly Core Documentation",
6
+ "publishConfig": {
7
+ "access": "public"
8
+ },
9
+ "scripts": {
10
+ "dev": "astro dev",
11
+ "start": "astro dev",
12
+ "build": "astro check && astro build",
13
+ "build:cli": "tsc --build ./cli/tsconfig.json",
14
+ "build:cli:watch": "tsc --build --watch ./cli/tsconfig.json",
15
+ "preview": "astro preview",
16
+ "astro": "astro",
17
+ "prettier": "prettier --write ./src",
18
+ "lint": "eslint . --cache --cache-strategy content",
19
+ "test": "jest",
20
+ "test:watch": "jest --watch",
21
+ "semantic-release": "semantic-release"
22
+ },
23
+ "main": "dist/cli/cli.js",
24
+ "bin": "./dist/cli/cli.js",
25
+ "prettier": {
26
+ "plugins": [
27
+ "prettier-plugin-astro"
28
+ ],
29
+ "overrides": [
30
+ {
31
+ "files": "*.astro",
32
+ "options": {
33
+ "parser": "astro"
34
+ }
35
+ }
36
+ ],
37
+ "semi": false,
38
+ "singleQuote": true,
39
+ "trailingComma": "all"
40
+ },
41
+ "dependencies": {
42
+ "@astrojs/check": "^0.9.4",
43
+ "@astrojs/react": "^4.1.5",
44
+ "@nanostores/react": "^0.8.0",
45
+ "@patternfly/patternfly": "^6.0.0",
46
+ "@patternfly/react-core": "^6.0.0",
47
+ "@types/react": "^18.3.12",
48
+ "@types/react-dom": "^18.3.1",
49
+ "astro": "^5.1.7",
50
+ "change-case": "5.4.4",
51
+ "glob": "^11.0.1",
52
+ "nanostores": "^0.11.3",
53
+ "react": "^18.3.1",
54
+ "react-dom": "^18.3.1",
55
+ "sass": "^1.81.0",
56
+ "typescript": "^5.6.3"
57
+ },
58
+ "devDependencies": {
59
+ "@babel/plugin-transform-modules-commonjs": "^7.26.3",
60
+ "@babel/preset-react": "^7.26.3",
61
+ "@babel/preset-typescript": "^7.26.0",
62
+ "@eslint/js": "^9.16.0",
63
+ "@semantic-release/git": "^10.0.1",
64
+ "@testing-library/jest-dom": "^6.6.3",
65
+ "@testing-library/react": "^16.1.0",
66
+ "@testing-library/user-event": "^14.5.2",
67
+ "@types/jest": "^29.5.14",
68
+ "@types/node": "^22.9.1",
69
+ "@typescript-eslint/eslint-plugin": "^8.17.0",
70
+ "@typescript-eslint/parser": "^8.17.0",
71
+ "babel-jest": "^29.7.0",
72
+ "commander": "^13.1.0",
73
+ "cz-conventional-changelog": "^3.3.0",
74
+ "eslint": "^9.16.0",
75
+ "eslint-config-prettier": "^9.1.0",
76
+ "eslint-plugin-astro": "^1.3.1",
77
+ "eslint-plugin-markdown": "^5.1.0",
78
+ "eslint-plugin-prettier": "^5.2.1",
79
+ "eslint-plugin-react": "^7.37.2",
80
+ "eslint-plugin-react-compiler": "^19.0.0-beta-df7b47d-20241124",
81
+ "eslint-plugin-react-hooks": "^5.1.0",
82
+ "globals": "^15.12.0",
83
+ "jest": "^29.7.0",
84
+ "jest-environment-jsdom": "^29.7.0",
85
+ "jsdom": "^25.0.1",
86
+ "prettier": "^3.4.2",
87
+ "prettier-plugin-astro": "^0.14.1",
88
+ "semantic-release": "^24.2.3",
89
+ "ts-jest": "^29.2.5",
90
+ "ts-node": "^10.9.2",
91
+ "typescript-eslint": "^8.15.0"
92
+ },
93
+ "config": {
94
+ "commitizen": {
95
+ "path": "./node_modules/cz-conventional-changelog"
96
+ }
97
+ }
98
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "recommendations": ["astro-build.astro-vscode"],
3
+ "unwantedRecommendations": []
4
+ }
@@ -0,0 +1,11 @@
1
+ {
2
+ "version": "0.2.0",
3
+ "configurations": [
4
+ {
5
+ "command": "./node_modules/.bin/astro dev",
6
+ "name": "Development server",
7
+ "request": "launch",
8
+ "type": "node-terminal"
9
+ }
10
+ ]
11
+ }
package/README.md ADDED
@@ -0,0 +1,49 @@
1
+ # Patternfly Documentation Core
2
+
3
+ Patternfly documentation core contains the base packages needed to build and release the PatternFly org website.
4
+
5
+ ## Consuming this repo as a package
6
+
7
+ ### Setup
8
+
9
+ Using this package for your documentation is accomplished in just a few simple steps:
10
+
11
+ 1. Run `npx patternfly-doc-core@latest setup` from the root of your repo. This will:
12
+ - add the documentation core as a dependency in your package
13
+ - add the relevant scripts for using the documentation core to your package scripts
14
+ - create the configuration file for customizing the documentation core
15
+ 1. Install the documentation core using your projects dependency manager, e.g. `npm install` or `yarn install`
16
+ 1. Run the initialization script using your script runner, e.g. `npm run init:docs` or `yarn init:docs`
17
+ - this will update a Vite config in the documentation so that it can access the files in your repo when running the development server
18
+ 1. Edit the `pf-docs.config.mjs` file in your project root to point the documentation core to your documentation files
19
+
20
+ ### Use
21
+
22
+ Once setup is complete you can start the dev server with the `start` script, and create production builds using the `build:docs` script!
23
+
24
+ ## Running this repo directly
25
+
26
+ ### Development
27
+
28
+ The website is built using [Astro](https://astro.build). Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
29
+
30
+ The `src/components/` folder contains Astro and React components that can be used to build the websites pages.
31
+
32
+ Any static assets, like images, can be placed in the `public/` directory.
33
+
34
+ To define the markdown schema this project uses a typescript based schema known as [Zod](https://zod.dev). Details of how this is integratred into Astro can be found in Astros documentation on [content creation using Zod](https://docs.astro.build/en/guides/content-collections/#defining-datatypes-with-zod).
35
+
36
+ ### 🧞 Commands
37
+
38
+ All commands are run from the root of the project, from a terminal:
39
+
40
+ | Command | Action |
41
+ | :------------------------ | :----------------------------------------------- |
42
+ | `npm install` | Installs dependencies |
43
+ | `npm run dev` | Starts local dev server at `localhost:4321` |
44
+ | `npm run build` | Build your production site to `./dist/` |
45
+ | `npm run preview` | Preview your build locally, before deploying |
46
+ | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
47
+ | `npm run astro -- --help` | Get help using the Astro CLI |
48
+ | `npm run build:cli` | Create a JS build of the documentation core CLI |
49
+ | `npm run build:cli:watch` | Run the CLI builder in watch mode |
@@ -0,0 +1,18 @@
1
+ // @ts-check
2
+ import { defineConfig } from 'astro/config';
3
+ import react from '@astrojs/react';
4
+
5
+ // https://astro.build/config
6
+ export default defineConfig({
7
+ integrations: [react()],
8
+ vite: {
9
+ ssr: {
10
+ noExternal: ["@patternfly/*", "react-dropzone"],
11
+ },
12
+ server: {
13
+ fs: {
14
+ allow: ['./']
15
+ }
16
+ }
17
+ }
18
+ });
@@ -0,0 +1,4 @@
1
+ module.exports = {
2
+ presets: ['@babel/preset-typescript', '@babel/preset-react'],
3
+ plugins: ['@babel/plugin-transform-modules-commonjs']
4
+ };