Skip to content

Commit 56ac380

Browse files
ZeroIntensityZeroIntensity
authored
Use a custom documentation site (#197)
Closes #184.
1 parent 7fe291b commit 56ac380

Some content is hidden

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

82 files changed

+6851
-0
lines changed

‎client/package-lock.json

Lines changed: 1025 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/.eslintrc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "next/core-web-vitals"
3+
}

‎docs/.gitignore

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
.yarn/install-state.gz
8+
9+
# testing
10+
/coverage
11+
12+
# next.js
13+
/.next/
14+
/out/
15+
16+
# production
17+
/build
18+
19+
# misc
20+
.DS_Store
21+
*.pem
22+
23+
# debug
24+
npm-debug.log*
25+
yarn-debug.log*
26+
yarn-error.log*
27+
28+
# local env files
29+
.env*.local
30+
31+
# vercel
32+
.vercel
33+
34+
# typescript
35+
*.tsbuildinfo
36+
next-env.d.ts

‎docs/.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
**/*.mdx

‎docs/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
2+
3+
## Getting Started
4+
5+
First, run the development server:
6+
7+
```bash
8+
npm run dev
9+
# or
10+
yarn dev
11+
# or
12+
pnpm dev
13+
# or
14+
bun dev
15+
```
16+
17+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18+
19+
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
20+
21+
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
22+
23+
## Learn More
24+
25+
To learn more about Next.js, take a look at the following resources:
26+
27+
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28+
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
29+
30+
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
31+
32+
## Deploy on Vercel
33+
34+
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
35+
36+
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

‎docs/mdx-components.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import React from "react";
2+
3+
export function useMDXComponents(components: React.ReactNode[]) {
4+
return { ...components };
5+
}

‎docs/next.config.mjs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
import withMDX from "@next/mdx";
2+
/** @type {import('next').NextConfig} */
3+
const nextConfig = withMDX()({
4+
pageExtensions: ["js", "jsx", "mdx", "ts", "tsx"],
5+
transpilePackages:
6+
process.env.NODE_ENV !== "development"
7+
? ["geist"]
8+
: ["geist", "hightlight.js"],
9+
});
10+
11+
/*
12+
https://github.com/vercel/geist-font/issues/59,
13+
https://github.com/highlightjs/highlight.js/issues/3982
14+
*/
15+
export default nextConfig;

‎docs/package.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"name": "docs",
3+
"version": "0.1.0",
4+
"private": true,
5+
"scripts": {
6+
"dev": "next dev",
7+
"build": "next build",
8+
"start": "next start",
9+
"lint": "next lint",
10+
"postbuild": "pagefind --site .next --output-path .next/static/chunks/pages/pagefind"
11+
},
12+
"dependencies": {
13+
"@mdx-js/loader": "^3.0.1",
14+
"@next/mdx": "^14.2.5",
15+
"clsx": "^2.1.1",
16+
"framer-motion": "^11.3.19",
17+
"geist": "^1.3.1",
18+
"highlight.js": "^11.10.0",
19+
"mini-css-extract-plugin": "^2.9.0",
20+
"mini-svg-data-uri": "^1.4.4",
21+
"next": "14.2.5",
22+
"react": "^18",
23+
"react-dom": "^18",
24+
"react-icons": "^5.2.1",
25+
"tailwind-merge": "^2.4.0"
26+
},
27+
"devDependencies": {
28+
"@types/node": "^22.0.0",
29+
"@types/react": "^18",
30+
"@types/react-dom": "^18",
31+
"eslint": "^9.8.0",
32+
"eslint-config-next": "14.2.5",
33+
"pagefind": "^1.1.0",
34+
"postcss": "^8.4.40",
35+
"tailwindcss": "^3.4.7",
36+
"typescript": "^5.5.4"
37+
},
38+
"type": "module"
39+
}

‎docs/postcss.config.mjs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/** @type {import('postcss-load-config').Config} */
2+
const config = {
3+
plugins: {
4+
tailwindcss: {},
5+
},
6+
};
7+
8+
export default config;

‎docs/public/logo-white.svg

Lines changed: 155 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)