Skip to content

Commit

Permalink
Autogenerated docs and setup for html-entities
Browse files Browse the repository at this point in the history
  • Loading branch information
oandregal committed Mar 6, 2019
1 parent 52355c4 commit ff73674
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
13 changes: 13 additions & 0 deletions packages/html-entities/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,17 @@ npm install @wordpress/html-entities --save

_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._

## API

<!-- START TOKEN(Autogenerated API docs) -->

### decodeEntities

[src/index.js#L3-L22](src/index.js#L3-L22)

Undocumented declaration.


<!-- END TOKEN(Autogenerated API docs) -->

<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
6 changes: 6 additions & 0 deletions packages/html-entities/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,13 @@
"dependencies": {
"@babel/runtime": "^7.3.1"
},
"devDependencies": {
"@wordpress/docgen": "file:../docgen"
},
"publishConfig": {
"access": "public"
},
"scripts": {
"docs:generate": "docgen ./src/index.js --output ./README.md --to-token"
}
}

0 comments on commit ff73674

Please sign in to comment.