640dee6645
Summary: Using `react-docgen` to automatically generate docs for our UI components. React-docgen parses the files in `components/ui` and using comments and flowtypes to generate structured information about the UI components. For higher-order-components `react-docgen` is not able to get the information. As we are using HOC often as part of emotion's styled-components, I added a custom parser for HOCs. Using babel/parser I am parsing the components and using their doc-comments to generate the structured description. Then, the description generated by react-docgen and my custom parser is used to generate markdown which is added to the `ui-components.md` file of our docs. Plus: Added some styling around the documentation of props, mostly table styles. Reviewed By: jknoxville Differential Revision: D12896110 fbshipit-source-id: 1337c924c06e10a5d3aa752579428fd2cc7b4743
21 lines
618 B
JSON
21 lines
618 B
JSON
{
|
|
"scripts": {
|
|
"examples": "docusaurus-examples",
|
|
"start": "yarn generate-uidocs && docusaurus-start",
|
|
"build": "yarn generate-uidocs && docusaurus-build",
|
|
"publish-gh-pages": "docusaurus-publish",
|
|
"write-translations": "docusaurus-write-translations",
|
|
"version": "docusaurus-version",
|
|
"rename-version": "docusaurus-rename-version",
|
|
"generate-uidocs": "node ./generate-uidocs.js"
|
|
},
|
|
"devDependencies": {
|
|
"@babel/parser": "^7.1.3",
|
|
"docblock-parser": "^1.0.0",
|
|
"docusaurus": "^1.0.9",
|
|
"glob": "^7.1.3",
|
|
"react-docgen": "^3.0.0-rc.1"
|
|
},
|
|
"dependencies": {}
|
|
}
|