Docs: use stackblitz for demo

This commit is contained in:
Fuma Nama
2025-03-23 20:53:26 +08:00
parent 68f5191082
commit a79180d3a2
4 changed files with 31 additions and 12 deletions
+3 -3
View File
@@ -256,7 +256,7 @@ function End() {
Read docs
</Link>
<a
href="https://githubbox.com/fuma-nama/fumadocs-ui-template"
href="https://stackblitz.com/~/github.com/fuma-nama/fumadocs-ui-template"
rel="noreferrer noopener"
className={cn(
buttonVariants({
@@ -264,7 +264,7 @@ function End() {
}),
)}
>
Open in CodeSandbox
Open Demo
</a>
</div>
</div>
@@ -456,7 +456,7 @@ function Hero() {
Getting Started
</Link>
<a
href="https://githubbox.com/fuma-nama/fumadocs-ui-template"
href="https://stackblitz.com/~/github.com/fuma-nama/fumadocs-ui-template"
target="_blank"
rel="noreferrer noopener"
className={cn(
+1 -1
View File
@@ -31,7 +31,7 @@ export function UwuHero(): React.ReactElement {
Getting Started
</Link>
<a
href="https://githubbox.com/fuma-nama/fumadocs-ui-template"
href="https://stackblitz.com/~/github.com/fuma-nama/fumadocs-ui-template"
className={cn(
buttonVariants({
size: 'lg',
+26 -7
View File
@@ -53,8 +53,6 @@ Some basic knowledge of Next.js App Router would be useful for further customisa
Create a new app with `create-fumadocs-app`.
Node.js 18 or above required, Node.js 23.1 might have problems with Next.js production build.
<Tabs groupId='package-manager' persist items={['npm', 'pnpm', 'yarn', 'bun']}>
```bash tab="npm"
@@ -75,6 +73,8 @@ bun create fumadocs-app
</Tabs>
> Node.js 18 or above required, Node.js 23.1 might have problems with Next.js production build.
It will initialize a new fumadocs app.
Now you can start hacking!
@@ -119,15 +119,34 @@ In the project, you can see:
Content source handles all your content, like compiling Markdown files and validating frontmatter.
- **Fumadocs MDX:** Read the [Introduction](/docs/mdx) to learn how it handles your content,
and customise different options like frontmatter schema. A `source.config.ts` config file has been included.
<Tabs items={['Fumadocs MDX', 'Custom Source']}>
- **Custom Source:** Fumadocs is not Markdown-exclusive. For other sources like Sanity, you can [build a custom content source](/docs/headless/custom-source).
<Tab value='Fumadocs MDX'>
Read the [Introduction](/docs/mdx) to learn how it handles your content.
A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
</Tab>
<Tab value='Custom Source'>
Fumadocs is not Markdown-exclusive. For other sources like Sanity, you can build a [custom content source](/docs/headless/custom-source).
</Tab>
</Tabs>
### Writing Content
Despite the supported syntax of MDX, Fumadocs has some additional features for authoring content too.
You can refer to [Markdown](/docs/ui/markdown).
<Cards>
<Card href="/docs/ui/markdown" title="Markdown">
Fumadocs has some additional features for authoring content too.
</Card>
<Card href="/docs/ui/page-conventions" title="Organizing Pages">
Learn how to organize your content.
</Card>
</Cards>
### Customise UI
@@ -30,7 +30,7 @@ Fumadocs MDX is also a useful library to handle MDX content in Next.js. It also
- Fast and optimized by default, natively built on App Router.
- Tight integration with Next.js, you can add it to an existing Next.js project easily.
Feel free to open the demo in CodeSandbox, or read [Comparisons](/docs/ui/comparisons) if you're interested.
You can read [Comparisons](/docs/ui/comparisons) if you're interested.
### Documentation