Skip to content

docs: use VitePress #4

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.

Sign up for GitHub

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

Merged
marinofranz merged 2 commits into from
Oct 29, 2025
Merged

docs: use VitePress #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1280941
docs: use vitepress for guides and api reference
marinofranz Oct 29, 2025
277cd5a
docs: add general and resource guides
marinofranz Oct 29, 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
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ jobs:
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
publish_dir: ./src/docs/.vitepress/dist
user_name: "github-actions[bot]"
user_email: "github-actions[bot]@users.noreply.github.com"

Expand Down
6 changes: 4 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
node_modules/
dist/
coverage/
docs/
.env
.env
src/docs/.vitepress/dist/
src/docs/.vitepress/cache/
src/docs/api/
2 changes: 1 addition & 1 deletion .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ dist
node_modules
pnpm-lock.yaml
CHANGELOG.md
docs
src/docs
coverage
30 changes: 29 additions & 1 deletion eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@ import tseslint from "typescript-eslint";

export default defineConfig([
{
ignores: ["docs/**", "coverage/**", "dist/**", "node_modules/**"],
ignores: [
"src/docs/.vitepress/**",
"coverage/**",
"dist/**",
"node_modules/**",
],
},
js.configs.recommended,
tseslint.configs.recommended,
Expand All @@ -18,4 +23,27 @@ export default defineConfig([
"no-console": "off",
},
},
{
files: ["scripts/**/*.mjs"],
languageOptions: {
ecmaVersion: "latest",
sourceType: "module",
globals: {
console: "readonly",
process: "readonly",
__dirname: "readonly",
__filename: "readonly",
},
},
rules: {
"no-console": "off",
"@typescript-eslint/no-unused-vars": [
"error",
{
argsIgnorePattern: "^_",
varsIgnorePattern: "^_",
},
],
},
},
]);
10 changes: 8 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@
"format": "prettier --write .",
"lint": "eslint .",
"lint:format": "prettier --check .",
"docs": "typedoc",
"docs:watch": "typedoc --watch"
"docs": "pnpm run docs:build",
"docs:api": "typedoc && node scripts/generate-api-sidebar.mjs",
"docs:dev": "pnpm run docs:api && vitepress dev src/docs",
"docs:build": "pnpm run docs:api && vitepress build src/docs",
"docs:preview": "vitepress preview src/docs"
},
"keywords": [
"roblox",
Expand Down Expand Up @@ -62,8 +65,11 @@
"semantic-release": "^25.0.1",
"tsup": "^8.5.0",
"typedoc": "^0.28.14",
"typedoc-plugin-markdown": "^4.9.0",
"typescript": "^5.9.3",
"typescript-eslint": "^8.46.1",
"vitepress": "^1.6.4",
"vitepress-plugin-group-icons": "^1.6.5",
"vitest": "^3.2.4"
}
}
Loading