Skip to content

Commit

Permalink
docs(next-tinacms-markdown): reformats helper interface & explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
kendallstrautman authored and ncphillips committed Aug 4, 2020
1 parent 1896866 commit 7a3fa99
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions packages/next-tinacms-markdown/README.md
Expand Up @@ -10,10 +10,17 @@ yarn add next-tinacms-markdown

## Helpers

- `useMarkdownForm( markdownFile, options? ):[values, form]` - A [React Hook](https://reactjs.org/docs/hooks-intro.html) for registering local forms with [function components](https://reactjs.org/docs/components-and-props.html#function-and-class-components).
- `markdownForm( Component, options? ): Component` - A [React Higher-Order Component](https://reactjs.org/docs/higher-order-components.html) for registering local forms with class or function components.
- `useLocalMarkdownForm`(deprecated)
- `useGlobalMarkdownForm`(deprecated)
```ts
useMarkdownForm( markdownFile, options? ):[values, form]
```
A [React Hook](https://reactjs.org/docs/hooks-intro.html) for registering local forms with [function components](https://reactjs.org/docs/components-and-props.html#function-and-class-components).
```ts
markdownForm( Component, options? ): Component
```
A [React Higher-Order Component](https://reactjs.org/docs/higher-order-components.html) for registering local forms with class or function components.
**Arguments**
Expand Down

0 comments on commit 7a3fa99

Please sign in to comment.