Skip to content

Commit

Permalink
fix broken docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
jacob-alford committed Jul 27, 2023
1 parent d865485 commit 7aeb7f3
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 27 deletions.
26 changes: 14 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ import * as S from 'schemata-ts'

In addition to "primitive" schemas like `S.String(params?)`, `S.Int(params?)`, `S.Boolean`, schemata-ts also exports schema _combinators_ from the root directory. 'Combinator' is a fancy word for a function that takes one or more schemas and returns a new schema. For example, `S.Array(S.String())` is a schema over an array of strings, and `S.Struct({ foo: S.String() })` is a schema over an object with a single property `foo` which is a string.

- [All Schemata](https://jacob-alford.github.io/schemata-ts/schemata)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Schema)
- [Docs](https://jacob-alford.github.io/schemata-ts/schemata)
- [Schemata Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata)
- [Docs](https://jacob-alford.github.io/schemata-ts/schema)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Schema.ts)
- [View All Schemata](https://jacob-alford.github.io/schemata-ts/schemata)
- [All Schemata Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata)

#### Example

Expand Down Expand Up @@ -153,7 +153,7 @@ const personTranscoder: Transcoder<PersonInput, Person> = deriveTranscoder(Perso
Transcoders are intended to succeed `Decoder`, `Encoder`, and `Codec` from `io-ts` v2. They contain two methods: `decode` and `encode`. The `decode` method takes an unknown value to an fp-ts `Either` type where the failure type is a `schemata-ts` error tree called `TranscodeError`, and the success type is the output type of the schema.

- [Documentation](https://jacob-alford.github.io/schemata-ts/transcoder)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Transcoder)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Transcoder.ts)

#### Transformations (_Advanced_)

Expand Down Expand Up @@ -204,7 +204,7 @@ const personTranscoderPar: TranscoderPar<PersonInput, Person> =
#### Documentation

- [Documentation](https://jacob-alford.github.io/schemata-ts/transcoder-par)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/TranscoderPar)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/TranscoderPar.ts)

## Type Guards

Expand All @@ -219,7 +219,7 @@ const guardPerson: Guard<Person> = deriveGuard(PersonSchema)
#### Documentation

- [Documentation](https://jacob-alford.github.io/schemata-ts/guard)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Guard)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Guard.ts)

## JSON Schema (Draft 7, 2019-09, and 2020-12)

Expand All @@ -236,7 +236,7 @@ const personJsonSchema2020 = deriveJsonSchema(PersonSchema, '2020-12')
#### Documentation

- [Documentation](https://jacob-alford.github.io/schemata-ts/json-schema)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/JsonSchema)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/JsonSchema.ts)

## Fast-Check Arbitraries

Expand All @@ -252,20 +252,22 @@ const personArbitrary = deriveArbitrary(PersonSchema).arbitrary(fc)
#### Documentation

- [Documentation](https://jacob-alford.github.io/schemata-ts/arbitrary)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Arbitrary)
- [Source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Arbitrary.ts)

## And more

Schemata has other derivations besides the ones above, below are links to those places in the documentation.

- [MergeSemigroup](https://jacob-alford.github.io/schemata-ts/merge-semigroup): A customizable schema specific deep-merge ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/MergeSemigroup))
- [Eq](https://jacob-alford.github.io/schemata-ts/eq): A schema-specific equality check ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Eq))
- [TypeString](https://jacob-alford.github.io/schemata-ts/type-string): Input / Output type strings ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/TypeString))
- [MergeSemigroup](https://jacob-alford.github.io/schemata-ts/merge-semigroup): A customizable schema specific deep-merge ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/MergeSemigroup.ts))
- [Eq](https://jacob-alford.github.io/schemata-ts/eq): A schema-specific equality check ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/Eq.ts))
- [TypeString](https://jacob-alford.github.io/schemata-ts/type-string): Input / Output type strings ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/TypeString.ts))

# Contributors ✨

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand Down
30 changes: 15 additions & 15 deletions docs/schemata/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,23 +81,23 @@ has_children: true

### String (17)

* Ascii ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Ascii.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Ascii.ts)) (e.g: `lIMxZM`, `||yxO`, `=G)2irii`)
* Base64 ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Base64.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Base64.ts)) (e.g: `+Lu7AX/=`, `NVH++mk+/+v+0/YZ0c/K/O58f2+2`, `m/+g+6ROo+XJuk+4/9/6/+OOxlc5+5++/O==`)
* Base64Url ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Base64Url.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Base64Url.ts)) (e.g: `dahC4N5-`, `_iW_XlU__`, `M_-Q_i-p`)
* BitcoinAddress ([docs](https://jacob-alford.github.io/schemata-ts/schemata/BitcoinAddress.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/BitcoinAddress.ts)) (e.g: `bc13c3zv59a0rpf3mr2fs833837f3iq1a2`, `3JJf4iiV8Zr2iGLk5CYM3n3hMM1GZuE3BMuNGGF`, `18P12ARNkcanKPe2A6xm5mVyQky4K3oa6M`)
* Ascii ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Ascii.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Ascii.ts)) (e.g: `|}bk|olz0`, `zzz^`, `z L7`)
* Base64 ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Base64.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Base64.ts)) (e.g: `0xa2/avy/+B/9Xlz/E8dD31C/9/i/bz/4061`, `ug+/5eDW4+2gW651+/S+4/+e99Qr/NKoX/g+`, `/2nE/XWR+Z+W/+0+`)
* Base64Url ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Base64Url.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Base64Url.ts)) (e.g: `_J4A4-`, `XX73aM_-`, `-c-E1Bh3`)
* BitcoinAddress ([docs](https://jacob-alford.github.io/schemata-ts/schemata/BitcoinAddress.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/BitcoinAddress.ts)) (e.g: `bc13o9e107pwpa1w8od30a2e02e8z`, `1GMfD4WUoDYVMMK297GPqwHuDXM`, `bc168j66u4ad207m8bcx6c28253xq3682`)
* CamelCaseString ([docs](https://jacob-alford.github.io/schemata-ts/schemata/CamelCaseString.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/CamelCaseString.ts)) (e.g: `Camel_case-string``camelCaseString`)
* CreditCard ([docs](https://jacob-alford.github.io/schemata-ts/schemata/CreditCard.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/CreditCard.ts)) (e.g: `628219927722601902`, `622923196369430047`, `628237302032668652`)
* EmailAddress ([docs](https://jacob-alford.github.io/schemata-ts/schemata/EmailAddress.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/EmailAddress.ts)) (e.g: `"뇹常⯨굞㱈඿幣"@[04.880.9.63]`, `//|L$|'{_=.*&_#%X39.7&*%%%*.{?~/$#+7*'@0X-rC9y-Hx.Nl.-s00.c-xLC1n3c.GjFdOO`, `"앜￰d"@[20.5.83.99]`)
* EthereumAddress ([docs](https://jacob-alford.github.io/schemata-ts/schemata/EthereumAddress.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/EthereumAddress.ts)) (e.g: `0xf3001F0A1fF0Ac1BabDEeAB0aDcB25671d67af2a`, `0x461ECdc3aeCBDdCf82d1a3Db88311AAB6D8Bb2ae`, `0xaBaCfCeeB7ac1b21a9abDfc0AbcAf29EAcec9C0f`)
* HexColor ([docs](https://jacob-alford.github.io/schemata-ts/schemata/HexColor.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/HexColor.ts)) (e.g: `#aE8c87C7`, `96eA933B`, `a160FCDa`)
* Hexadecimal ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Hexadecimal.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Hexadecimal.ts)) (e.g: `b8cDab2C2E7`, `D7eBaf`, `0HEa741EBE7`)
* HslColor ([docs](https://jacob-alford.github.io/schemata-ts/schemata/HslColor.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/HslColor.ts)) (e.g: `hsl(+.4e+0852268055500.2992010122e87849%00.42307%)`, `hsl(.107,00000000.674944202917%,+0000000096e0%)`, `hsl(6415835095,00000000100%,00000006%,76829e061036751%)`)
* Jwt ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Jwt.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Jwt.ts)) (e.g: `U_V_82._5K6J___9-`, `X-8_.-6Q-t-`, `_.__u-Lfy_9_.68`)
* LatLong ([docs](https://jacob-alford.github.io/schemata-ts/schemata/LatLong.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/LatLong.ts)) (e.g: `(90.0,+70)`, `90,-180.00000`, `(+90,180)`)
* NonEmptyString ([docs](https://jacob-alford.github.io/schemata-ts/schemata/NonEmptyString.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/NonEmptyString.ts)) (e.g: `VR/Ehq`, `wKfJr8p3nW==`, `V@?`)
* RGB ([docs](https://jacob-alford.github.io/schemata-ts/schemata/RGB.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/RGB.ts)) (e.g: `rgb(100%,100%,100%)`, `rgba(211,93,228,0.7872)`, `rgb(98%,94%,100%)`)
* CreditCard ([docs](https://jacob-alford.github.io/schemata-ts/schemata/CreditCard.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/CreditCard.ts)) (e.g: `6506817189223137`, `50841130246372976`, `8269313616861171`)
* EmailAddress ([docs](https://jacob-alford.github.io/schemata-ts/schemata/EmailAddress.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/EmailAddress.ts)) (e.g: `3.3~.|7&%?/.###.D|}?+j.~.%%lS|=?%.'{./#$'}!-@-K2x.C--7iNxZ.-U984-b.-E.j9.gw--M.-o-Vf2--D.-CzK-9.-.3fV.yGBnh`, `|8c*&+1~&_.}~}#^*^=|.&}.+~n?&^*/*^{.?-|-$-.#!^*O/@BPvL-0.8F.-b.ksi69oKU30.wCDCBX`, `_&^[email protected]`)
* EthereumAddress ([docs](https://jacob-alford.github.io/schemata-ts/schemata/EthereumAddress.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/EthereumAddress.ts)) (e.g: `0x206f1ebD1b3fac408EB8CaF02b75EAEEeCb9a2C5`, `0x91EBEbefbfbfaaeB8BcFCAcecbfaBCEA7BC2AB7A`, `0xD0EbDc6DBBabeCC1FEba6eCC2BEB0BDAf17Cae1D`)
* HexColor ([docs](https://jacob-alford.github.io/schemata-ts/schemata/HexColor.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/HexColor.ts)) (e.g: `fFecFBAd`, `#49fF3c6F`, `#DaAF5b93`)
* Hexadecimal ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Hexadecimal.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Hexadecimal.ts)) (e.g: `0h6DaaEcA`, `0HdfbA8EdD`, `0H2007FcB89bE`)
* HslColor ([docs](https://jacob-alford.github.io/schemata-ts/schemata/HslColor.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/HslColor.ts)) (e.g: `hsl(.12turn,0000090%,0000000.221%)`, `hsl(+59791745300.8431817turn000000100e+36888500882%+000100e433520122%/1774351291%)`, `hsla(74134deg,000000000100%,+00000100e-22591153%)`)
* Jwt ([docs](https://jacob-alford.github.io/schemata-ts/schemata/Jwt.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/Jwt.ts)) (e.g: `-___.-I_9-Z`, `g-W_WE.`, `-.jvB-50-6.-B-HpW2p6-`)
* LatLong ([docs](https://jacob-alford.github.io/schemata-ts/schemata/LatLong.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/LatLong.ts)) (e.g: `(+90,-180)`, `13,180`, `+90,172`)
* NonEmptyString ([docs](https://jacob-alford.github.io/schemata-ts/schemata/NonEmptyString.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/NonEmptyString.ts)) (e.g: `64565f175`, `c33aff343d`, `ertyI${has`)
* RGB ([docs](https://jacob-alford.github.io/schemata-ts/schemata/RGB.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/RGB.ts)) (e.g: `rgb(100%,95%,20%)`, `rgb(253,212,120)`, `rgba(100%,100%,74%,.39)`)
* String ([docs](https://jacob-alford.github.io/schemata-ts/schemata/String.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/String.ts))
* UUID ([docs](https://jacob-alford.github.io/schemata-ts/schemata/UUID.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/UUID.ts)) (e.g: `ffe3221C-Befc-ECEF-bef7-0a389CbA7db6`, `fEEecdD8-fcFc-0CFB-B913-3E7d8aBFbeF3`, `cCdd4CeB-CAFa-E3Da-EB3E-Eb1cDbDfdC7e`)
* UUID ([docs](https://jacob-alford.github.io/schemata-ts/schemata/UUID.html)) ([source](https://github.com/jacob-alford/schemata-ts/tree/main/src/schemata/UUID.ts)) (e.g: `5AcFBc6e-eBCC-FBbc-DF3A-33F0A1fF11c0`, `2B3aF6aa-401D-afCF-A08A-FebBedDfAfed`, `fCdBb1a4-bedE-Bed2-1385-AF0FAA923EDc`)

### Unknown (3)

Expand Down

0 comments on commit 7aeb7f3

Please sign in to comment.