diff --git a/docs/.nojekyll b/.nojekyll
similarity index 100%
rename from docs/.nojekyll
rename to .nojekyll
diff --git a/README.md b/README.md
index b0f19fed7..d598de8ed 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@
+
@@ -28,11 +29,11 @@
These docs have been translated into [Chinese](./README_ZH.md).
-# Table of contents
+## Table of contents
+#### Go to [zod.js.org](https://zod.js.org) >> -->
- [What is Zod](#what-is-zod)
- [Installation](#installation)
@@ -70,7 +71,7 @@ These docs have been translated into [Chinese](./README_ZH.md).
- [Maps](#maps)
- [Sets](#sets)
- [Unions](#unions)
- - [Discriminated Unions](#discriminated-unions)
+ - [Discriminated Unions](#discriminated-unions)
- [Recursive types](#recursive-types)
- [JSON type](#json-type)
- [Cyclical data](#cyclical-objects)
@@ -107,7 +108,7 @@ These docs have been translated into [Chinese](./README_ZH.md).
-# What is Zod
+## What is Zod
Zod is a TypeScript-first schema declaration and validation library. I'm using the term "schema" to broadly refer to any data type, from a simple `string` to a complex nested object.
@@ -123,7 +124,7 @@ Some other great aspects:
- Functional approach: [parse, don't validate](https://lexi-lambda.github.io/blog/2019/11/05/parse-don-t-validate/)
- Works with plain JavaScript too! You don't need to use TypeScript.
-# Sponsorship
+## Sponsorship
Sponsorship at any level is appreciated and encouraged. For individual developers, consider the [Cup of Coffee tier](https://github.com/sponsors/colinhacks). If you built a paid product using Zod, consider one of the [podium tiers](https://github.com/sponsors/colinhacks).
@@ -242,7 +243,7 @@ Sponsorship at any level is appreciated and encouraged. For individual developer
-# Installation
+## Installation
To install Zod v3:
@@ -263,13 +264,13 @@ npm install zod
}
```
-#### TypeScript requirements
+### TypeScript requirements
- Zod 3.x requires TypeScript 4.1+
- Zod 2.x requires TypeScript 3.7+
- Zod 1.x requires TypeScript 3.3+
-# Ecosystem
+## Ecosystem
There are a growing number of tools that are built atop or support Zod natively! If you've built a tool or library on top of Zod, tell me about it [on Twitter](https://twitter.com/colinhacks) or [start a Discussion](https://github.com/colinhacks/zod/discussions). I'll add it below and tweet it out.
@@ -303,7 +304,7 @@ There are a growing number of tools that are built atop or support Zod natively!
- [`zod-formik-adapter`](https://github.com/robertLichtnow/zod-formik-adapter): A community-maintained Formik adapter for Zod
- [`react-zorm`](https://github.com/esamattis/react-zorm): Standalone `
"}]).links={}:(t=[{type:"html",text:e}]).links={}),o({token:i,embedToken:t}),++l>=s&&o({})}}(t);t.embed.url?ce(t.embed.url).then(r):r(t.embed.html)}}({compile:n,embedTokens:s,fetch:t},function(e){var t,n=e.embedToken,e=e.token;e?(t=e.index,u.forEach(function(e){t>e.start&&(t+=e.length)}),y(c,n.links),a=a.slice(0,t).concat(n,a.slice(t+1)),u.push({start:t,length:n.length-1})):(zn[i]=a.concat(),a.links=zn[i].links=c,r(a))})}function Mn(e,t,n){var r,i,o,a;return t="function"==typeof n?n(t):"string"==typeof n?(o=[],a=0,(r=n).replace(B,function(t,e,n){o.push(r.substring(a,n-1)),a=n+=t.length+1,o.push(i&&i[t]||function(e){return("00"+("string"==typeof Z[t]?e[Z[t]]():Z[t](e))).slice(-t.length)})}),a!==r.length&&o.push(r.substring(a)),function(e){for(var t="",n=0,r=e||new Date;n