chore: setup nextra
This commit is contained in:
parent
910217b5d0
commit
e3b417078d
7 changed files with 38 additions and 48 deletions
|
|
@ -1,30 +0,0 @@
|
|||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
|
||||
```bash
|
||||
yarn dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
|
||||
|
||||
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
|
||||
|
||||
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn/foundations/about-nextjs) - an interactive Next.js tutorial.
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
|
||||
|
||||
## Deploy on Vercel
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_source=github.com&utm_medium=referral&utm_campaign=turborepo-readme) from the creators of Next.js.
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
|
||||
|
|
@ -1,4 +1,6 @@
|
|||
module.exports = {
|
||||
reactStrictMode: true,
|
||||
transpilePackages: ["ui"],
|
||||
};
|
||||
const withNextra = require("nextra")({
|
||||
theme: "nextra-theme-docs",
|
||||
themeConfig: "./theme.config.tsx",
|
||||
})
|
||||
|
||||
module.exports = withNextra()
|
||||
|
|
|
|||
|
|
@ -9,19 +9,21 @@
|
|||
"lint": "next lint"
|
||||
},
|
||||
"dependencies": {
|
||||
"next": "^13.1.1",
|
||||
"next": "^13.3.0",
|
||||
"nextra": "^2.4.0",
|
||||
"nextra-theme-docs": "^2.4.0",
|
||||
"react": "^18.2.0",
|
||||
"react-dom": "^18.2.0",
|
||||
"ui": "*"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/core": "^7.0.0",
|
||||
"eslint": "7.32.0",
|
||||
"eslint-config-custom": "*",
|
||||
"tsconfig": "*",
|
||||
"@types/node": "^17.0.12",
|
||||
"@types/react": "^18.0.22",
|
||||
"@types/react-dom": "^18.0.7",
|
||||
"eslint": "7.32.0",
|
||||
"eslint-config-custom": "*",
|
||||
"tsconfig": "*",
|
||||
"typescript": "^4.5.3"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
5
apps/docs/pages/_meta.json
Normal file
5
apps/docs/pages/_meta.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"index": "My Homepage",
|
||||
"contact": "Contact Us",
|
||||
"about": "About Us"
|
||||
}
|
||||
3
apps/docs/pages/index.mdx
Normal file
3
apps/docs/pages/index.mdx
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Welcome to Nextra
|
||||
|
||||
Hello, world!
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
import { Button } from "ui";
|
||||
|
||||
export default function Docs() {
|
||||
return (
|
||||
<div>
|
||||
<h1>Docs</h1>
|
||||
<Button />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
18
apps/docs/theme.config.tsx
Normal file
18
apps/docs/theme.config.tsx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
import React from "react"
|
||||
import { DocsThemeConfig } from "nextra-theme-docs"
|
||||
|
||||
const config: DocsThemeConfig = {
|
||||
logo: <span>My Project</span>,
|
||||
project: {
|
||||
link: "https://github.com/shuding/nextra-docs-template",
|
||||
},
|
||||
chat: {
|
||||
link: "https://discord.com",
|
||||
},
|
||||
docsRepositoryBase: "https://github.com/shuding/nextra-docs-template",
|
||||
footer: {
|
||||
text: "Nextra Docs Template",
|
||||
},
|
||||
}
|
||||
|
||||
export default config
|
||||
Loading…
Add table
Add a link
Reference in a new issue