Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Renewed documentation #103

Merged
merged 28 commits into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
ee0c18b
refactor: Rename docs directory to docs-old
jungpaeng Dec 13, 2024
a6b35d5
chore(docs): Init nextra
jungpaeng Dec 14, 2024
62416db
feat(docs): Add Nextra configuration
jungpaeng Dec 14, 2024
ffcea8b
feat(docs): Add typscript configuration
jungpaeng Dec 14, 2024
41b3fb8
feat(i18n): Add i18n
jungpaeng Dec 15, 2024
63b9048
feat(docs): Update logo in theme configuration
jungpaeng Dec 15, 2024
973b3eb
feat(docs): Integrate Stylex for styling and update configuration
jungpaeng Dec 15, 2024
6517e72
feat(docs): Add Main component and index.mdx file
jungpaeng Dec 15, 2024
5ea5d8c
chore(docs): Add @codesandbox/sandpack-react dependency
jungpaeng Dec 16, 2024
1e2dcf5
chore(docs): Add remark-sandpack for enhanced MDX support
jungpaeng Dec 16, 2024
9166185
feat(docs): Add Sandpack components
jungpaeng Dec 16, 2024
8e03647
feat(docs): Add korean guide document
jungpaeng Dec 16, 2024
2727f6c
feat(docs): Add Korean documentation for overlay functionality
jungpaeng Dec 16, 2024
06e146e
feat(docs): Update overlay-kit introduction docs
jungpaeng Dec 18, 2024
edb858d
feat(docs): Update thinking in overlay-kit docs
jungpaeng Dec 18, 2024
257df2f
feat(docs): Add overlay-kit example to document
jungpaeng Dec 18, 2024
7e3bb70
feat(docs): Add new line to document
jungpaeng Dec 18, 2024
abdf14e
feat(docs): Add documentation for overlay positioning and examples
jungpaeng Dec 18, 2024
6ae11da
feat(docs): Add documentation for overlay-kit api
jungpaeng Dec 18, 2024
17f2bbf
docs: main page (#101)
manudeli Dec 26, 2024
f36a68f
feat(docs): Remove hard coding in Main component
jungpaeng Jan 13, 2025
02f0c32
feat(docs): Update guides docs
jungpaeng Jan 13, 2025
319111f
docs: Update overlay unmount with setTimeout
jungpaeng Jan 13, 2025
0c87650
docs: Update overlay api docs
jungpaeng Jan 15, 2025
e91df9a
docs: Add en document routes
jungpaeng Jan 15, 2025
4784167
docs: Set theme config
jungpaeng Jan 15, 2025
b50eff2
docs: Translate documentation to English
jungpaeng Feb 3, 2025
e221c7d
Create spotty-rules-joke.md
jungpaeng Feb 3, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .DS_Store
Binary file not shown.
5 changes: 5 additions & 0 deletions .changeset/spotty-rules-joke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"docs-old": patch
---

docs: Renewed documentation
19 changes: 19 additions & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
yarnPath: .yarn/releases/yarn-4.5.1.cjs
nodeLinker: "node-modules"

packageExtensions:
# Nextra dependencies
"acorn-jsx@^5.0.0":
dependencies:
acorn: ^8.0.0
"[email protected]":
dependencies:
"@chevrotain/regexp-to-ast": 11.0.3
vscode-languageserver-types: 3.17.5
vscode-jsonrpc: 8.2.0
# stylex
"@stylexswc/nextjs-plugin@^0.5.0":
dependencies:
"@stylexswc/webpack-plugin": ^0.5.0
"@stylexswc/webpack-plugin@^0.5.0":
dependencies:
"@stylexswc/rs-compiler": ^0.5.0
Binary file added docs-old/.DS_Store
Binary file not shown.
1 change: 1 addition & 0 deletions docs-old/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vitepress/cache
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions docs-old/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"name": "docs-old",
"private": true,
"devDependencies": {
"vitepress": "^1.2.2"
},
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
}
}
Binary file added docs-old/public/.DS_Store
Binary file not shown.
Binary file added docs-old/public/favicon-100x100.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-old/public/logo-black.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-old/public/logo-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-old/public/og.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.vitepress/cache
.next
5 changes: 5 additions & 0 deletions docs/next-env.d.ts
Original file line number Diff line number Diff line change
@@ -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/pages/api-reference/config/typescript for more information.
23 changes: 23 additions & 0 deletions docs/next.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import stylexPlugin from '@stylexswc/nextjs-plugin';
import nextra from 'nextra';
import { remarkSandpack } from 'remark-sandpack';

const withNextra = nextra({
theme: 'nextra-theme-docs',
themeConfig: './theme.config.tsx',
mdxOptions: {
remarkPlugins: [remarkSandpack],
},
});

export default stylexPlugin({
useCSSLayers: true,
})(
withNextra({
i18n: {
locales: ['en', 'ko'],
defaultLocale: 'en',
},
eslint: { ignoreDuringBuilds: true },
})
);
35 changes: 29 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
{
"name": "docs",
"private": true,
"devDependencies": {
"vitepress": "^1.2.2"
},
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
"dev": "next",
"build": "next build",
"start": "next start"
},
"type": "commonjs",
"dependencies": {
"@codesandbox/sandpack-react": "^2.19.10",
"@react-three/drei": "^9.120.4",
"@react-three/fiber": "^8.17.10",
"@stylexjs/stylex": "^0.9.3",
"@stylexswc/nextjs-plugin": "^0.5.0",
"@suspensive/react": "^2.18.10",
"codehike": "^1.0.4",
"motion": "^11.15.0",
"next": "^15.1.2",
"nextra": "^3.2.5",
"nextra-theme-docs": "^3.2.5",
"react": "^18.0.0",
"react-dom": "^18.0.0",
"remark-sandpack": "^0.0.5",
"three": "^0.171.0",
"zod": "^3.24.1"
},
"devDependencies": {
"@types/node": "22.10.2",
"@types/react": "^18",
"@types/react-dom": "^18",
"@types/three": "^0",
"typescript": "^5"
}
}
2 changes: 2 additions & 0 deletions docs/src/components/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from './main';
export * from './sandpack';
Loading