Skip to content

Commit 8ee51ba

Browse files
committed
Added Nextra docs
1 parent 55b0f65 commit 8ee51ba

44 files changed

Lines changed: 6628 additions & 300 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.prettierignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Ignore artifacts:
22
build
3-
fixtures
3+
fixtures
4+
# A bug when using code block inside tab elements
5+
docs/pages/index.mdx

.prettierrc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "useTabs": false }
1+
{ "useTabs": false, "proseWrap": "always" }

docs/.github/screenshot.png

868 KB
Loading

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.next
2+
node_modules

docs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Nextra Docs Template
2+
3+
This is a template for creating documentation with [Nextra](https://nextra.site).
4+
5+
[**Live Demo →**](https://nextra-docs-template.vercel.app)
6+
7+
[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
8+
9+
## Quick Start
10+
11+
Click the button to clone this repository and deploy it on Vercel:
12+
13+
[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
14+
15+
## Local Development
16+
17+
First, run `pnpm i` to install the dependencies.
18+
19+
Then, run `pnpm dev` to start the development server and visit localhost:3000.
20+
21+
## License
22+
23+
This project is licensed under the MIT License.

docs/next-env.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/// <reference types="next" />
2+
/// <reference types="next/image-types/global" />
3+
4+
// NOTE: This file should not be edited
5+
// see https://nextjs.org/docs/basic-features/typescript for more information.

docs/next.config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
const withNextra = require('nextra')({
2+
theme: 'nextra-theme-docs',
3+
themeConfig: './theme.config.tsx',
4+
})
5+
6+
module.exports = withNextra()

docs/package.json

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "docs",
3+
"version": "0.0.1",
4+
"description": "Nextra docs template",
5+
"scripts": {
6+
"dev": "next dev",
7+
"build": "next build",
8+
"start": "next start"
9+
},
10+
"repository": {
11+
"type": "git",
12+
"url": "git+https://github.com/shuding/nextra-docs-template.git"
13+
},
14+
"author": "Shu Ding <g@shud.in>",
15+
"license": "MIT",
16+
"bugs": {
17+
"url": "https://github.com/shuding/nextra-docs-template/issues"
18+
},
19+
"homepage": "https://github.com/shuding/nextra-docs-template#readme",
20+
"dependencies": {
21+
"next": "^13.0.6",
22+
"nextra": "latest",
23+
"nextra-theme-docs": "latest",
24+
"react": "^18.2.0",
25+
"react-dom": "^18.2.0"
26+
},
27+
"devDependencies": {
28+
"@types/node": "18.11.10",
29+
"typescript": "^4.9.3"
30+
}
31+
}

docs/pages/_App.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import "../styles.css";
2+
3+
export default function MyApp({ Component, pageProps }) {
4+
return <Component {...pageProps} />;
5+
}

docs/pages/_meta.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"index": "Introduction",
3+
"installation": "Installation",
4+
"tutorial": "Tutorial",
5+
"recommendations": "Recommendations",
6+
"advanced": "Advanced"
7+
}

0 commit comments

Comments
 (0)