@bleedingdev/modern-js-app-tools 3.5.0-ultramodern.99 → 3.8.1-ultramodern.2

package/docs/guides/get-started/quick-start.mdx

@@ -1,92 +0,0 @@
----
-title: Quick Start
-sidebar_position: 2
----
-
-# Quick Start
-
-## Environment
-
-import Prerequisites from '@site-docs-en/components/prerequisites';
-
-<Prerequisites />
-
-## Installation
-
-## Initialize
-
-import InitApp from '@site-docs-en/components/init-app';
-
-<InitApp />
-
-## Development
-
-import DebugApp from '@site-docs-en/components/debug-app';
-
-<DebugApp />
-
-## Configuration
-
-In an UltraModern.js project created using `@bleedingdev/modern-js-create`, a `modern.config.ts` file is generated by default.
-
-You can modify the configuration through this file to override the default behavior of Modern.js. For example, to enable SSR, add the following configuration:
-
-```ts title="modern.config.ts"
-import { appTools, defineConfig } from '@modern-js/app-tools';
-
-export default defineConfig({
-  server: {
-    ssr: true,
-  },
-  plugins: [appTools()],
-});
-```
-
-After running `pnpm run dev` again, you can find that the project has completed page rendering on the server in the browser's Network menu.
-
-## Core npm Package
-
-In a newly created project, the `@modern-js/app-tools` npm package is installed by default. It is the core package of the Modern.js framework and provides the following capabilities:
-
-- It offers commonly used CLI commands such as `modern dev`, `modern build`, and more.
-- It integrates Rsbuild, providing build capabilities.
-- It integrates Modern.js Server, providing capabilities for development and production servers.
-
-`@modern-js/app-tools` is implemented based on the plugin system of Modern.js. Essentially, it is a plugin. Therefore, you need to register `appTools` in the `plugins` field of the configuration file:
-
-```ts title="modern.config.ts"
-import { appTools, defineConfig } from '@modern-js/app-tools';
-
-export default defineConfig({
-  plugins: [appTools()],
-});
-```
-
-## Build the project
-
-import BuildOutput from '@site-docs-en/components/build-output';
-
-<BuildOutput />
-
-## Verify
-
-Run `pnpm run serve` in the project to verify whether the build artifacts run normally locally:
-
-```bash
-$ pnpm run serve
-
-  Modern.js Framework
-
-info    Starting production server...
-
-  > Local:    http://localhost:8080/
-  > Network:  http://192.168.0.1:8080/
-```
-
-Open `http://localhost:8080/` in the browser, and the content should be consistent with that of `pnpm run dev`.
-
-## Deployment
-
-import Deploy from '@site-docs-en/components/deploy';
-
-<Deploy />

package/docs/guides/topic-detail/_meta.json

@@ -1,8 +0,0 @@
-[
-  {
-    "type": "dir",
-    "name": "module-federation",
-    "label": "module-federation",
-    "collapsed": true
-  }
-]

package/docs/guides/topic-detail/module-federation/_meta.json

@@ -1 +0,0 @@
-["introduce", "usage", "application", "ssr", "deploy", "i18n"]

package/docs/guides/troubleshooting/_meta.json

@@ -1 +0,0 @@
-["dependencies", "cli", "builder", "hmr"]

package/docs/guides/upgrade/_meta.json

@@ -1 +0,0 @@
-["overview", "config", "entry", "web-server", "tailwindcss", "other"]

package/scripts/copy-main-doc.mjs

@@ -1,50 +0,0 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-// Copies the English docs from packages/document into this package as
-// `docs/`, so every project gets version-matched offline docs
-// for AI coding agents (see AGENTS.md generated by @modern-js/create).
-// Runs as part of `build` (see package.json build script + nx build
-// outputs), so the bundle is produced whenever the package is built —
-// including in CI/release where publish runs with `--ignore-scripts` and
-// prepublishOnly would be skipped. The directory is gitignored, so it only
-// materializes as a build output, never committed to the working tree.
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const pkgRoot = path.resolve(__dirname, '..');
-const source = path.resolve(pkgRoot, '../../document/docs/en');
-// Bundle root: docs land directly under `docs/` (no `docs/en` nesting) to
-// keep the path agents read as short as possible.
-const target = path.resolve(pkgRoot, 'docs');
-
-// Top-level doc sections excluded from the bundle to keep it small.
-// Agents rarely need these while coding (blog/showcase, narrative
-// tutorials, framework-plugin authoring); llms.txt covers them online.
-// Keep this list in sync with scripts/check-doc-bundle.mjs.
-export const EXCLUDED_SECTIONS = ['community', 'tutorials', 'plugin'];
-
-if (!fs.existsSync(source)) {
-  console.error(`[copy-main-doc] source docs not found: ${source}`);
-  process.exit(1);
-}
-
-fs.rmSync(target, { recursive: true, force: true });
-fs.mkdirSync(path.dirname(target), { recursive: true });
-fs.cpSync(source, target, {
-  recursive: true,
-  filter: src => {
-    const rel = path.relative(source, src);
-    const top = rel.split(path.sep)[0];
-    return rel === '' || !EXCLUDED_SECTIONS.includes(top);
-  },
-});
-
-const count = fs
-  .readdirSync(target, { recursive: true, withFileTypes: true })
-  .filter(entry => entry.isFile()).length;
-
-if (count === 0) {
-  console.error('[copy-main-doc] no files copied');
-  process.exit(1);
-}
-console.log(`[copy-main-doc] bundled ${count} doc files into docs`);