Skip to content

Commit 092a6c0

Browse files
committed
update docs
1 parent 2a908c1 commit 092a6c0

File tree

6 files changed

+22
-2
lines changed

6 files changed

+22
-2
lines changed

demo/src/app.rs

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ fn TheRouter() -> impl IntoView {
5858
<Route path=path!("/server-sider-rendering") view=ServerSiderRenderingMdPage />
5959
<Route path=path!("/development/components") view=DevelopmentComponentsMdPage />
6060
<Route path=path!("/customize-theme") view=CustomizeThemeMdPage />
61+
<Route path=path!("/FAQs") view=FAQsMdPage />
6162
</ParentRoute>
6263
<ParentRoute path=path!("/components") view=ComponentsPage>
6364
<Route path=path!("/accordion") view=AccordionMdPage />

demo/src/pages/components.rs

+5
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,11 @@ pub(crate) fn gen_nav_data() -> Vec<NavGroupOption> {
158158
value: "/guide/customize-theme",
159159
label: "Customize Theme",
160160
},
161+
NavItemOption {
162+
group: None,
163+
value: "/guide/FAQs",
164+
label: "FAQs",
165+
},
161166
],
162167
},
163168
// NavGroupOption {

demo/src/pages/home.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ pub fn Home() -> impl IntoView {
3939
<Button
4040
appearance=ButtonAppearance::Primary
4141
on_click=move |_| {
42-
navigate("/components/button", Default::default());
42+
navigate("/guide/installation", Default::default());
4343
}
4444
>
4545
"Read the docs"

demo_markdown/docs/_guide/FAQs.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# FAQs
2+
3+
TODO

demo_markdown/docs/_guide/installation.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Installation
22

3-
Installation thaw
3+
Installation thaw.
44

55
```shell
66
cargo add thaw --features=csr
@@ -14,6 +14,14 @@ cargo add thaw --features=csr
1414
</MessageBarBody>
1515
</MessageBar>
1616

17+
<MessageBar intent=MessageBarIntent::Warning attr:style="margin-top: 12px">
18+
<MessageBarBody>
19+
<div style="white-space: normal">
20+
"Currently Thaw supports CSR and SSR. Island is not supported yet."
21+
</div>
22+
</MessageBarBody>
23+
</MessageBar>
24+
1725
## Usage
1826

1927
You just need to import thaw and use it.
@@ -38,6 +46,8 @@ fn main() {
3846
#[component]
3947
pub fn App() -> impl IntoView {
4048
view! {
49+
// The ConfigProvider component is required for Thaw,
50+
// please place it at the root of the Thaw component.
4151
<ConfigProvider>
4252
<Button appearance=ButtonAppearance::Primary>
4353
"Primary"

demo_markdown/src/lib.rs

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ pub fn include_md(_token_stream: proc_macro::TokenStream) -> proc_macro::TokenSt
2424
"InstallationMdPage" => "../docs/_guide/installation.md",
2525
"ServerSiderRenderingMdPage" => "../docs/_guide/server_sider_rendering.md",
2626
"CustomizeThemeMdPage" => "../docs/_guide/theme/customize_theme.md",
27+
"FAQsMdPage" => "../docs/_guide/FAQs.md",
2728
"AccordionMdPage" => "../../thaw/src/accordion/docs/mod.md",
2829
"AnchorMdPage" => "../../thaw/src/anchor/docs/mod.md",
2930
"AutoCompleteMdPage" => "../../thaw/src/auto_complete/docs/mod.md",

0 commit comments

Comments
 (0)