Skip to content

Commit

Permalink
fix: api reference link
Browse files Browse the repository at this point in the history
  • Loading branch information
hanayashiki committed Apr 5, 2023
1 parent 4827178 commit f0f054b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 30 deletions.
36 changes: 12 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,20 @@
# mobx-zod-form
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/MonoidDev/mobx-zod-form/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/MonoidDev/mobx-zod-form/tree/master)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FMonoidDev%2Fmobx-zod-form.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2FMonoidDev%2Fmobx-zod-form?ref=badge_shield)
![npm](https://img.shields.io/npm/v/@monoid-dev/mobx-zod-form?label=mobx-zod-form)
![npm](https://img.shields.io/npm/v/@monoid-dev/mobx-zod-form-react?label=mobx-zod-form-react)


<img src="https://raw.githubusercontent.com/MonoidDev/mobx-zod-form/master/packages/website/public/favicon.svg" width="256" height="256" alt="Logo" />

<br />

Data-first form builder based on [MobX](https://mobx.js.org/) & [Zod](https://zod.dev/).

## Supported types

1. `ZodString`
2. `ZodNumber`
3. `ZodBoolean`
4. `ZodEnum`
5. `ZodOptional`
6. `ZodNullable`
7. `ZodLiteral`
8. `ZodAny`
9. `ZodObject`
10. `ZodArray`
11. `ZodDefault`
12. `ZodDiscriminatedUnion`
13. `ZodEffects`
14. `MobxZodBox`

## Learn More

Documentation (WIP):
https://mobx-zod-form.pages.dev/
<br />

## Checkout our Documentation

Documentation:
https://mobx-zod-form.pages.dev/


## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FMonoidDev%2Fmobx-zod-form.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FMonoidDev%2Fmobx-zod-form?ref=badge_large)
2 changes: 1 addition & 1 deletion packages/website/src/pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"guide": "Guide",
"api-reference": {
"title": "API Reference ↗",
"href": "/api-reference/modules.html",
"href": "/api-reference/index.html",
"newWindow": true
}
}
10 changes: 5 additions & 5 deletions packages/website/src/pages/guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ The following types are mapped to an atomic `MobxZodField`.
6. `ZodNullable`
7. `ZodLiteral`

See [interface MobxZodField](packages/website/out/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodField.html)
See [interface MobxZodField](/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodField.html)

#### MobxZodOptionalField & MobxZodNullableField

Expand All @@ -258,25 +258,25 @@ The following types are mapped to an `MobxZodOptionalField<T>` or `MobxZodNullab
1. `ZodOptional<T>`
2. `ZodDefault<T>`

See [interface MobxZodOmittableField](packages/website/out/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodOmittableField.html)
See [interface MobxZodOmittableField](/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodOmittableField.html)

#### MobxZodObjectField

`ZodObject` will be mapped to this field.

See [interface MobxZodObjectField](packages/website/out/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodObjectField.html)
See [interface MobxZodObjectField](/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodObjectField.html)

#### MobxZodArrayField

`ZodArray` will be mapped to this field.

See [interface MobxZodArrayField](packages/website/out/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodArrayField.html)
See [interface MobxZodArrayField](/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodArrayField.html)

#### Discriminated Union

`ZodDiscriminatedUnion` will be mapped to `MobxZodDiscriminatedUnionField`.

See [interface MobxZodDiscriminatedUnionField](packages/website/out/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodDiscriminatedUnionField.html)
See [interface MobxZodDiscriminatedUnionField](/api-reference/interfaces/_monoid_dev_mobx_zod_form.MobxZodDiscriminatedUnionField.html)


### Boxed Fields
Expand Down

0 comments on commit f0f054b

Please sign in to comment.