|
1 | | -# meshjs-docs |
| 1 | +# MeshJS Documentation |
2 | 2 |
|
3 | | -This is a Next.js application generated with |
4 | | -[Create Fumadocs](https://github.com/fuma-nama/fumadocs). |
| 3 | +Documentation platform for MeshJS built with Next.js and Fumadocs. |
5 | 4 |
|
6 | | -Run development server: |
| 5 | +## Structure |
7 | 6 |
|
8 | | -```bash |
9 | | -npm run dev |
10 | | -# or |
11 | | -pnpm dev |
12 | | -# or |
13 | | -yarn dev |
14 | | -``` |
| 7 | +- `app/(home)` - Landing page |
| 8 | +- `app/docs` - Documentation layout and pages |
| 9 | +- `app/api/search` - Search functionality |
| 10 | +- `lib/source.ts` - Content source adapter |
| 11 | +- `content/docs/` - MDX documentation files |
| 12 | +- `components/` - Reusable React components |
15 | 13 |
|
16 | | -Open http://localhost:3000 with your browser to see the result. |
| 14 | +## Features |
17 | 15 |
|
18 | | -## Explore |
19 | | - |
20 | | -In the project, you can see: |
21 | | - |
22 | | -- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content. |
23 | | -- `app/layout.config.tsx`: Shared options for layouts, optional but preferred to keep. |
24 | | - |
25 | | -| Route | Description | |
26 | | -| ------------------------- | ------------------------------------------------------ | |
27 | | -| `app/(home)` | The route group for your landing page and other pages. | |
28 | | -| `app/docs` | The documentation layout and pages. | |
29 | | -| `app/api/search/route.ts` | The Route Handler for search. | |
30 | | - |
31 | | -### Fumadocs MDX |
32 | | - |
33 | | -A `source.config.ts` config file has been included, you can customise different options like frontmatter schema. |
34 | | - |
35 | | -Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details. |
36 | | - |
37 | | -## Learn More |
38 | | - |
39 | | -To learn more about Next.js and Fumadocs, take a look at the following |
40 | | -resources: |
41 | | - |
42 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js |
43 | | - features and API. |
44 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
45 | | -- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs |
| 16 | +- Up-to-date documentation |
| 17 | +- AI-powered search and assistance |
| 18 | +- llms.txt file for AI code editors |
0 commit comments