Skip to content

Commit 3ad7a2c

Browse files
committed
Update docs
1 parent 0ed3a35 commit 3ad7a2c

File tree

5 files changed

+12
-73
lines changed

5 files changed

+12
-73
lines changed

docs/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/_site
2+
/.jekyll-cache
3+
/assets
4+
/Gemfile.lock

docs/Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
77
# gem "rails"
88

99
gem "jekyll", "~> 4.2"
10+
gem "just-the-docs"

docs/Gemfile.lock

Lines changed: 0 additions & 67 deletions
This file was deleted.

docs/_config.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
theme: "just-the-docs"
2+
baseurl: "/typed-react-form"
13
remote_theme: pmarsceill/just-the-docs
24

35
aux_links:
4-
"GitHub":
5-
- "https://github.com/CodeStix/typed-react-form"
6-
6+
"GitHub":
7+
- "https://github.com/CodeStix/typed-react-form"
78

89
aux_links_new_tab: true
910

@@ -12,4 +13,4 @@ gh_edit_link_text: "Edit this page on GitHub."
1213
gh_edit_repository: "https://github.com/CodeStix/typed-react-form" # the github URL for your repo
1314
gh_edit_branch: "master" # the branch that your docs is served from
1415
gh_edit_source: docs # the source that your files originate from
15-
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
16+
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

src/FieldError.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ export function FieldError<
2424
*
2525
* **Examples**
2626
*
27-
* `<FieldError as="textarea" rows={10} />`
27+
* `<FieldError as="span" style={{color: "red"}} />`
2828
*
29-
* `<FieldError as={CustomInput} {...} />`
29+
* `<FieldError as={CustomError} {...} />`
3030
*/
3131
as?: C;
3232
transformer?: (error: Error) => React.ReactNode;

0 commit comments

Comments
 (0)