@patternfly/documentation-framework 1.0.3-rc1 → 1.0.3
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/README.md +40 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,43 @@
|
|
|
1
1
|
# @patternfly/documentation-framework
|
|
2
2
|
|
|
3
|
+
## The PatternFly documentation framework lets you develop component examples in markdown format, so that they can be added to [patternfly.org](https://www.patternfly.org/v4/).
|
|
4
|
+
|
|
3
5
|
## Install
|
|
4
6
|
|
|
5
7
|
We publish this theme [on npm.](https://www.npmjs.com/package/@patternfly/documentation-framework) Install it as a devDependency with your package manager.
|
|
6
8
|
|
|
7
|
-
|
|
9
|
+
1. @patternfly/documentation-framework
|
|
10
|
+
|
|
11
|
+
`npm i --save-dev @patternfly/documentation-framework`
|
|
12
|
+
|
|
13
|
+
or
|
|
14
|
+
|
|
15
|
+
`yarn add -D @patternfly/documentation-framework`
|
|
16
|
+
|
|
17
|
+
2. Provide or install the following either as dependencies if you want to use them in your own project, or as devDependencies:
|
|
18
|
+
```
|
|
19
|
+
"@patternfly/patternfly": "^4.185.1",
|
|
20
|
+
"@patternfly/react-core": "^4.202.16",
|
|
21
|
+
"@patternfly/react-table": "^4.71.16",
|
|
22
|
+
"@patternfly/react-code-editor": "^4.43.16",
|
|
23
|
+
```
|
|
24
|
+
`yarn add -D @patternfly/patternfly @patternfly/react-core @patternfly/react-table @patternfly/react-code-editor`
|
|
8
25
|
|
|
9
|
-
|
|
26
|
+
### Resolutions
|
|
27
|
+
|
|
28
|
+
This should be needed, but if you encounter errors installing the above devDependencies, try adding one or more of these resolutions to your package.json file:
|
|
29
|
+
```
|
|
30
|
+
"resolutions": {
|
|
31
|
+
"@types/react": "^16.8.0",
|
|
32
|
+
"@types/react-dom": "^16.8.0",
|
|
33
|
+
"react": "16.8.0",
|
|
34
|
+
"react-dom": "16.8.0",
|
|
35
|
+
"chromedriver": "102.0.0",
|
|
36
|
+
"node-sass": "7.0.1",
|
|
37
|
+
"puppeteer": "14.3.0",
|
|
38
|
+
"sharp": "0.30.6"
|
|
39
|
+
}
|
|
40
|
+
```
|
|
10
41
|
|
|
11
42
|
## First time setup
|
|
12
43
|
|
|
@@ -89,4 +120,10 @@ You can generate screenshots against development or production builds.
|
|
|
89
120
|
|
|
90
121
|
Terminal 2:
|
|
91
122
|
|
|
92
|
-
`yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:5000`
|
|
123
|
+
`yarn docs:screenshots` or `npx pf-docs-framework screenshots --urlPrefix http://localhost:5000`
|
|
124
|
+
|
|
125
|
+
### Publish docs to patternfly.org
|
|
126
|
+
|
|
127
|
+
1. Include the `patternfly-docs/content` and `patternfly-docs/generated` folders as part of your npm published module
|
|
128
|
+
|
|
129
|
+
2. Create a PR at [patternfly-org](https://github.com/patternfly/patternfly-org) to bundle in the package's examples so that they're part of the patternfly.org documentation.
|