Merge pull request #159 from 1chooo/docs/#158

feat(docs): add nextra docs template (#158)
1chooo · Oct 21, 2024 · 4ab031c · 4ab031c
2 parents e810af3 + 8879fdb
commit 4ab031c
Show file tree

Hide file tree

Showing 27 changed files with 2,394 additions and 73 deletions.
diff --git a/docs/.github/screenshot.png b/docs/.github/screenshot.png
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,2 @@
+.next
+node_modules
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
diff --git a/docs/LICENSE b/docs/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shu Ding
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docs/Note/developing.md b/docs/Note/developing.md
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,23 @@
+# Nextra Docs Template 
+
+This is a template for creating documentation with [Nextra](https://nextra.site).
+
+[**Live Demo →**](https://nextra-docs-template.vercel.app)
+
+[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
+
+## Quick Start
+
+Click the button to clone this repository and deploy it on Vercel:
+
+[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgh.neting.cc%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
+
+## Local Development
+
+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/docs/REFERENCE.md b/docs/REFERENCE.md
diff --git a/docs/about.md b/docs/about.md
diff --git a/docs/components/counters.module.css b/docs/components/counters.module.css
@@ -0,0 +1,6 @@
+.counter {
+  border: 1px solid #ccc;
+  border-radius: 5px;
+  padding: 2px 6px;
+  margin: 12px 0 0;
+}
diff --git a/docs/components/counters.tsx b/docs/components/counters.tsx
@@ -0,0 +1,24 @@
+// Example from https://beta.reactjs.org/learn
+
+import { useState } from 'react'
+import styles from './counters.module.css'
+
+function MyButton() {
+  const [count, setCount] = useState(0)
+
+  function handleClick() {
+    setCount(count + 1)
+  }
+
+  return (
+    <div>
+      <button onClick={handleClick} className={styles.counter}>
+        Clicked {count} times
+      </button>
+    </div>
+  )
+}
+
+export default function MyApp() {
+  return <MyButton />
+}
diff --git a/docs/cover.png b/docs/cover.png
diff --git a/docs/next-env.d.ts b/docs/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/docs/next.config.js b/docs/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/docs/package.json b/docs/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": "latest",
+    "nextra-theme-docs": "latest",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "18.11.10",
+    "typescript": "^4.9.3"
+  }
+}
diff --git a/docs/pages/_meta.json b/docs/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/docs/pages/about.mdx b/docs/pages/about.mdx
@@ -0,0 +1,3 @@
+# About
+
+This is the about page! This page is shown on the navbar.
diff --git a/docs/pages/advanced.mdx b/docs/pages/advanced.mdx
@@ -0,0 +1,3 @@
+# Advanced
+
+This is the index page for the Advanced folder!
diff --git a/docs/pages/advanced/satori.mdx b/docs/pages/advanced/satori.mdx
@@ -0,0 +1,3 @@
+# Satori
+
+Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".
diff --git a/docs/pages/another.mdx b/docs/pages/another.mdx
@@ -0,0 +1,31 @@
+# Another Page
+
+```js filename="demo.js" {3} copy
+let a = 1;
+
+console.log(a);
+```
+
+## Component
+
+import { useState } from 'react'
+
+{/* Import CSS modules */}
+import styles from '../components/counters.module.css'
+
+export const Counter = () => {
+  const [count, setCount] = useState(0);
+  return (
+    <div>
+      <button onClick={() => setCount(count + 1)} className={styles.counter}>Clicked {count} times</button>
+    </div>
+  );
+};
+
+<Counter/>
+
+## External Component
+
+import Counters from '../components/counters'
+
+<Counters />
diff --git a/docs/index.md → docs/pages/index.mdx b/docs/index.md → docs/pages/index.mdx
@@ -7,10 +7,11 @@
 Enabling everyone unfamiliar with programming languages to easily engage with AI and open the doors to the world of the future.
 
 ## Refinaid Team
+
 <table>
   <tr>
     <td align="center"><a href="https://1chooo-github-io.vercel.app/"><img src="https://avatars.githubusercontent.com/u/94162591?v=4" width="100px;" alt=""/><br /><sub><b>1chooo</b></sub></a><br /><a href="https://github.com/1chooo/simple-ai/commits?author=1chooo" title="Code">💻 🧳</a></td>
     <td align="center"><a href="https://github.com/ReeveWu"><img src="https://avatars.githubusercontent.com/u/110542858?v=4" width="100px;" alt=""/><br /><sub><b>ReeveWu</b></sub></a><br /><a href="https://github.com/1chooo/simple-ai/commits?author=ReeveWu" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/VincentLi1216"><img src="https://avatars.githubusercontent.com/u/98581766?v=4" width="100px;" alt=""/><br /><sub><b>VincentLi1216</b></sub></a><br /><a href="https://github.com/1chooo/simple-ai/commits?author=VincentLi1216" title="Code">💻</a></td>
   </tr>
-</table>
+</table>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# About

		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 @@
		# Advanced

		This is the index page for the Advanced folder!
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Satori

		Satori (悟り) is a Japanese Buddhist term for awakening, "comprehension; understanding".