Skip to content

Commit

Permalink
⚙️ Chore(docs): Initialize Docs with Nextra
Browse files Browse the repository at this point in the history
  • Loading branch information
INeedJobToStartWork committed Mar 31, 2024
1 parent 682991b commit 1c9dc80
Show file tree
Hide file tree
Showing 8 changed files with 2,689 additions and 62 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ npm-debug.log*
**/.env.test.local
**/.env.production.local
**/.env.local
## Next
**/.next/**
1 change: 1 addition & 0 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# `docs`
11 changes: 11 additions & 0 deletions apps/docs/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import NextraConfig from "nextra";

const withNextra = NextraConfig({
theme: "nextra-theme-docs",
themeConfig: "./theme.config.jsx",
});

export default withNextra();

// If you have other Next.js configurations, you can pass them as the parameter:
// module.exports = withNextra({ /* other next.js config */ })
25 changes: 25 additions & 0 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"name": "docs",
"version": "0.0.0",
"private": true,
"type":"module",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start",
"test": "echo 'Add test script here'",
"lint": "echo 'Add lint script here'"
},
"devDependencies": {
"eslintrc": "workspace:*",
"prettierrc": "workspace:*",
"tsconfigrc": "workspace:*"
},
"dependencies": {
"next": "^14.1.4",
"nextra": "^2.13.4",
"nextra-theme-docs": "^2.13.4",
"react": "^18.2.0",
"react-dom": "^18.2.0"
}
}
3 changes: 3 additions & 0 deletions apps/docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Welcome to Nextra

Hello, world!
7 changes: 7 additions & 0 deletions apps/docs/theme.config.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default {
logo: <span>My Nextra Documentation</span>,
project: {
link: "https://github.com/shuding/nextra",
},
// ... other theme options
};
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
"bugs": "https://github.com/ineedjobtostartwork/fluidui/issues/new/choose",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"dev": "turbo dev",
"build:npm": "turbo build:npm",
"lint": "turbo lint",
"lint:fix": "turbo lint",
"format": "turbo format",
Expand Down
Loading

0 comments on commit 1c9dc80

Please sign in to comment.