create-rspress 1.36.0 → 1.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/README.md +28 -1
  2. package/bin.js +2 -0
  3. package/dist/index.js +18 -8028
  4. package/package.json +27 -28
  5. package/template-basic/doc_build/404.html +17 -0
  6. package/template-basic/doc_build/guide/index.html +146 -0
  7. package/template-basic/doc_build/hello.html +19 -0
  8. package/template-basic/doc_build/index.html +17 -0
  9. package/template-basic/doc_build/static/css/styles.b2b1631f.css +1 -0
  10. package/template-basic/doc_build/static/js/21.ec2c01fe.js +2 -0
  11. package/template-basic/doc_build/static/js/21.ec2c01fe.js.LICENSE.txt +21 -0
  12. package/template-basic/doc_build/static/js/async/194.62189d7d.js +1 -0
  13. package/template-basic/doc_build/static/js/async/599.4a892881.js +1 -0
  14. package/template-basic/doc_build/static/js/async/918.8c28cdf5.js +1 -0
  15. package/template-basic/doc_build/static/js/index.b77560ea.js +6 -0
  16. package/template-basic/doc_build/static/js/index.b77560ea.js.LICENSE.txt +13 -0
  17. package/template-basic/doc_build/static/js/lib-react.958723e2.js +2 -0
  18. package/template-basic/doc_build/static/js/lib-react.958723e2.js.LICENSE.txt +39 -0
  19. package/template-basic/doc_build/static/js/lib-router.2fc64dcb.js +2 -0
  20. package/template-basic/doc_build/static/js/lib-router.2fc64dcb.js.LICENSE.txt +32 -0
  21. package/template-basic/doc_build/static/js/styles.c233f00f.js +1 -0
  22. package/template-basic/doc_build/static/search_index.1427c47e.json +1 -0
  23. package/{template → template-basic}/docs/index.md +4 -4
  24. package/template-basic/docs/public/rspress-dark-logo.png +0 -0
  25. package/template-basic/docs/public/rspress-icon.png +0 -0
  26. package/template-basic/docs/public/rspress-light-logo.png +0 -0
  27. package/template-basic/node_modules/.bin/rspress +17 -0
  28. package/{template → template-basic}/package.json +1 -1
  29. package/{template → template-basic}/rspress.config.ts +7 -4
  30. package/template-common/README.md +29 -0
  31. package/template-common/gitignore +14 -0
  32. package/dist/index.d.ts +0 -2
  33. package/template/_gitignore +0 -25
  34. /package/{template/docs/public → template-basic/doc_build}/rspress-dark-logo.png +0 -0
  35. /package/{template/docs/public → template-basic/doc_build}/rspress-icon.png +0 -0
  36. /package/{template/docs/public → template-basic/doc_build}/rspress-light-logo.png +0 -0
  37. /package/{template → template-basic}/docs/_meta.json +0 -0
  38. /package/{template → template-basic}/docs/guide/_meta.json +0 -0
  39. /package/{template → template-basic}/docs/guide/index.md +0 -0
  40. /package/{template → template-basic}/docs/hello.md +0 -0
  41. /package/{template → template-common}/tsconfig.json +0 -0
package/README.md CHANGED
@@ -1,3 +1,30 @@
1
1
  # create-rspress
2
2
 
3
- The scaffolding tool to create a new rspress project.
3
+ Create a new Rspress project.
4
+
5
+ Using `npm create`:
6
+
7
+ ```bash
8
+ npm create rspress@latest
9
+ ```
10
+
11
+ Using CLI flags:
12
+
13
+ ```bash
14
+ npx create-rspress --dir my-project
15
+
16
+ # Using abbreviations
17
+ npx create-rspress -d my-project
18
+ ```
19
+
20
+ ## Documentation
21
+
22
+ https://rspress.dev/
23
+
24
+ ## Contributing
25
+
26
+ Please read the [Contributing Guide](https://github.com/web-infra-dev/rspress/blob/main/CONTRIBUTING.md).
27
+
28
+ ## License
29
+
30
+ Rspress is [MIT licensed](https://github.com/web-infra-dev/rspress/blob/main/LICENSE).
package/bin.js ADDED
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ import './dist/index.js';