Skip to content

Commit

Permalink
docs: move docs under /web (#433)
Browse files Browse the repository at this point in the history
  • Loading branch information
yyx990803 committed Mar 5, 2024
1 parent 5cf2c6b commit fe0a569
Show file tree
Hide file tree
Showing 13 changed files with 28 additions and 9 deletions.
3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,3 @@
- For contribution guide, please refer to the deployed version at: https://rolldown.rs/dev-guide/

- The source is also in this repo: https://github.com/rolldown-rs/rolldown/blob/main/web/docs/dev-guide/
4 changes: 2 additions & 2 deletions .gitignore
Expand Up @@ -165,8 +165,8 @@ pkg/
justfile*

# vitepress
docs/.vitepress/cache
web/docs/.vitepress/cache

# ci release avoid lerna error: Working tree has uncommitted changes
crates/rolldown_binding/artifacts/
packages/**/THIRD-PARTY-LICENSE
packages/**/THIRD-PARTY-LICENSE
2 changes: 1 addition & 1 deletion .ls-lint.yml
Expand Up @@ -13,6 +13,6 @@ ignore:
- 'crates/rolldown/tests/fixtures/**/_test.js' # `_test.js` is a special file, which will be treat as the entry file while executing the build output of fixture.
- packages/node/build.config.ts # convention name for using unbuild
- packages/node/vitest.config.ts
- docs/.vitepress/cache # cache files generated by vitepress
- web/docs/.vitepress/cache # cache files generated by vitepress
# FIXME: should not ignore following folders
- web
1 change: 0 additions & 1 deletion CONTRIBUTING

This file was deleted.

4 changes: 0 additions & 4 deletions package.json
Expand Up @@ -32,9 +32,6 @@
"typecheck": "yarn workspace @rolldown/node run typecheck",
"bench": "yarn workspace bench run bench",
"build:ts": "tsc -b tsconfig.project.json",
"docs:dev": "vitepress dev docs",
"docs:build": "vitepress build docs",
"docs:preview": "vitepress preview docs",
"TODO(hyf0): #need to investigate following commands": "_",
"build:ci:release": "run-s build:node:ci build:binding:release",
"build:node:ci": "yarn workspace @rolldown/node run build",
Expand Down Expand Up @@ -62,7 +59,6 @@
"tree-sitter": "^0.20.6",
"tree-sitter-go": "^0.20.0",
"typescript": "^5.0.0",
"vitepress": "^1.0.0-rc.44",
"zx": "^7.2.0"
},
"prettier": {
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions web/docs/package.json
@@ -0,0 +1,14 @@
{
"name": "rolldown-docs",
"version": "0.1.0",
"type": "module",
"private": true,
"scripts": {
"dev": "vitepress dev",
"build": "vitepress build",
"preview": "vitepress preview"
},
"devDependencies": {
"vitepress": "^1.0.0-rc.44"
}
}
9 changes: 8 additions & 1 deletion yarn.lock
Expand Up @@ -8480,7 +8480,6 @@ __metadata:
tree-sitter: "npm:^0.20.6"
tree-sitter-go: "npm:^0.20.0"
typescript: "npm:^5.0.0"
vitepress: "npm:^1.0.0-rc.44"
zx: "npm:^7.2.0"
languageName: unknown
linkType: soft
Expand Down Expand Up @@ -10535,6 +10534,14 @@ __metadata:
languageName: node
linkType: hard

"rolldown-docs@workspace:web/docs":
version: 0.0.0-use.local
resolution: "rolldown-docs@workspace:web/docs"
dependencies:
vitepress: "npm:^1.0.0-rc.44"
languageName: unknown
linkType: soft

"rolldown-playground@workspace:web/playground":
version: 0.0.0-use.local
resolution: "rolldown-playground@workspace:web/playground"
Expand Down

0 comments on commit fe0a569

Please sign in to comment.