rspress 1.0.0-beta.5 → 1.0.2

package/README.md

@@ -1 +1,42 @@
-# rspress
+# Rspress
+
+<picture>
+  <img alt="Rspress Banner" src="https://github.com/web-infra-dev/rspress/assets/39261479/999e7946-45ff-45d5-b9cd-594e634e0e5a">
+</picture>
+
+<h2 align="center">A fast Rspack-based static site generator.</h2>
+
+## Features
+
+- **🚀 Fast Startup**: Based on Rust-based build tool and markdown/mdx compiler, the build speed is extremely fast, bringing you the ultimate development experience.
+- **📚 MDX Support**: MDX is a powerful way to write content, allowing you to use React components in Markdown.
+- **📦 Built-in Full Text Search**: Automatically generates a full-text search index for you during building process, providing out-of-the-box full-text search capabilities.
+- **🌈 Static Site Generation**: In production, it automatically builds into static HTML files, which can be easily deployed anywhere.
+- **🔌 Providing Plugin System**: Providing a plugin system, you can customize the build process and theme according to your needs.
+- **📝 Component Document**: Support multi ways to preview your component demo.
+
+## Getting Started
+
+Go to the [Quick Start](https://rspress.dev/guide/start/getting-started.html) to get started.
+
+## Contribution
+
+Please read the [contributing guide](./CONTRIBUTING.md) and let's build Rspress together.
+
+If you have any quesions, you can open an issue or go to [Discord](https://discord.com/channels/977448667919286283/1161653869080756245) to communicate with us.
+
+### Code of Conduct
+
+This repo has adopted the ByteDance Open Source Code of Conduct. Please check [Code of Conduct](./CODE_OF_CONDUCT.md) for more details.
+
+### Links
+
+| Name                                                       | Description                             |
+| ---------------------------------------------------------- | --------------------------------------- |
+| [@rspress/mdx-rs](https://github.com/web-infra-dev/mdx-rs) | Rust MDX compiler for Rspress.          |
+| [Rspack](https://github.com/web-infra-dev/rspack)          | A fast Rust-based web bundler.          |
+| [Rsbuild](https://github.com/web-infra-dev/rsbuild)        | An Rspack-based build tool for the web. |
+
+### License
+
+Rspress is licensed under the [MIT License](./LICENSE).

package/dist/index.js

@@ -55,11 +55,7 @@ async function loadConfigFile(customConfigFile) {
 }
 
 // src/index.ts
-var CONFIG_FILES = [
-  "rspress.config.ts",
-  "rspress.config.js",
-  "_meta.json"
-];
+var CONFIG_FILES = ["rspress.config.ts", "rspress.config.js", "_meta.json"];
 var require2 = createRequire2(import.meta.url);
 var packageJson = require2("../package.json");
 var cli = cac("rspress").version(packageJson.version).help();
@@ -90,22 +86,22 @@ cli.command("[root]", "start dev server").alias("dev").action(async (root, optio
       docDirectory,
       config
     });
-    cliWatcher = chokidar.watch([
-      `${cwd}/**/{${CONFIG_FILES.join(",")}}`,
-      docDirectory
-    ], {
-      ignoreInitial: true,
-      ignored: [
-        "**/node_modules/**",
-        "**/.git/**",
-        "**/.DS_Store/**"
-      ]
-    });
+    cliWatcher = chokidar.watch(
+      [`${cwd}/**/{${CONFIG_FILES.join(",")}}`, docDirectory],
+      {
+        ignoreInitial: true,
+        ignored: ["**/node_modules/**", "**/.git/**", "**/.DS_Store/**"]
+      }
+    );
     cliWatcher.on("all", async (eventName, filepath) => {
       if (eventName === "add" || eventName === "unlink" || eventName === "change" && CONFIG_FILES.includes(path2.basename(filepath))) {
-        console.log(`
-✨ ${eventName} ${chalk.green(path2.relative(cwd, filepath))}, dev server will restart...
-`);
+        console.log(
+          `
+✨ ${eventName} ${chalk.green(
+            path2.relative(cwd, filepath)
+          )}, dev server will restart...
+`
+        );
         await devServer.close();
         await cliWatcher.close();
         await startDevServer();
@@ -133,14 +129,16 @@ cli.command("build [root]").option("-c --config <config>", "specify config file"
     config
   });
 });
-cli.command("preview").alias("serve").option("-c --config <config>", "specify config file").option("--port [port]", "port number").option("--host [host]", "hostname").action(async (options) => {
-  setNodeEnv("production");
-  const { port, host } = options || {};
-  const config = await loadConfigFile(options?.config);
-  await serve({
-    config,
-    host,
-    port
-  });
-});
+cli.command("preview").alias("serve").option("-c --config <config>", "specify config file").option("--port [port]", "port number").option("--host [host]", "hostname").action(
+  async (options) => {
+    setNodeEnv("production");
+    const { port, host } = options || {};
+    const config = await loadConfigFile(options?.config);
+    await serve({
+      config,
+      host,
+      port
+    });
+  }
+);
 cli.parse();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rspress",
-  "version": "1.0.0-beta.5",
+  "version": "1.0.2",
   "type": "module",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -28,12 +28,12 @@
     }
   },
   "dependencies": {
-    "@modern-js/node-bundle-require": "2.35.1",
+    "@modern-js/node-bundle-require": "2.36.0",
     "cac": "^6.7.14",
     "chokidar": "^3.5.3",
     "chalk": "5.3.0",
-    "@rspress/core": "1.0.0-beta.5",
-    "@rspress/shared": "1.0.0-beta.5"
+    "@rspress/core": "1.0.2",
+    "@rspress/shared": "1.0.2"
   },
   "devDependencies": {
     "@types/jest": "~29.2.4",