init project

shuding · shuding · commit cf73ae2dfe06 · 2022-12-02T10:30:33.000+01:00
diff --git a/.github/screenshot.png b/.github/screenshot.png
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.next
+node_modules
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# Nextra Docs Template
+
+This is a template for creating documentation with [Nextra](https://nextra.site).
+
+![](.github/screenshot.png)
+
+## Getting Started
+
+First, run `pnpm i` to install the dependencies.
+
+Then, run `pnpm dev` to start the development server and visit localhost:3000.
+
+## License
+
+This project is licensed under the MIT License.
diff --git a/next-env.d.ts b/next-env.d.ts
@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.
diff --git a/next.config.js b/next.config.js
@@ -0,0 +1,6 @@
+const withNextra = require('nextra')({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.tsx',
+})
+
+module.exports = withNextra()
diff --git a/package.json b/package.json
@@ -0,0 +1,31 @@
+{
+  "name": "nextra-docs-template",
+  "version": "0.0.1",
+  "description": "Nextra docs template",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shuding/nextra-docs-template.git"
+  },
+  "author": "Shu Ding <g@shud.in>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/shuding/nextra-docs-template/issues"
+  },
+  "homepage": "https://github.com/shuding/nextra-docs-template#readme",
+  "dependencies": {
+    "next": "^13.0.6",
+    "nextra": "^2.0.0-beta.45",
+    "nextra-theme-docs": "^2.0.0-beta.45",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.10",
+    "typescript": "^4.9.3"
+  }
+}
diff --git a/pages/_meta.json b/pages/_meta.json
@@ -0,0 +1,15 @@
+{
+  "index": "Introduction",
+  "another": "Another Page",
+  "advanced": "Advanced (A Folder)",
+  "about": {
+    "title": "About",
+    "type": "page"
+  },
+  "contact": {
+    "title": "Contact ↗",
+    "type": "page",
+    "href": "https://twitter.com/shuding_",
+    "newWindow": true
+  }
+}
diff --git a/pages/about.mdx b/pages/about.mdx
@@ -0,0 +1,3 @@
+# About
+
+This is the about page! This page is shown on the navbar.
diff --git a/pages/advanced.mdx b/pages/advanced.mdx
@@ -0,0 +1,3 @@
+# Advanced
+
+This is the index page for the Advanced folder!
diff --git a/pages/advanced/satori.mdx b/pages/advanced/satori.mdx
@@ -0,0 +1,3 @@
+# Satori
+
+Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".
diff --git a/pages/another.mdx b/pages/another.mdx
@@ -0,0 +1,7 @@
+# Another Page
+
+```js filename="demo.js" {3} copy
+let a = 1;
+
+console.log(a);
+```
diff --git a/pages/index.mdx b/pages/index.mdx
@@ -0,0 +1,11 @@
+# Introduction
+ 
+Welcome to Nextra! This is a basic docs template. You can use it as a starting point for your own project :)
+
+## What is Nextra?
+
+A **simple**, **powerful** and **flexible** site generation framework with everything you love from Next.js.
+
+## Documentation
+
+The documentation is available at [https://nextra.site](https://nextra.site).
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/theme.config.tsx b/theme.config.tsx
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# About`
	`2`	`+`
	`3`	`+This is the about page! This page is shown on the navbar.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Advanced`
	`2`	`+`
	`3`	`+This is the index page for the Advanced folder!`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Satori`
	`2`	`+`
	`3`	`+Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".`