@deot/docs 1.0.1

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.
package/README.md ADDED
@@ -0,0 +1,71 @@
1
+ # @deot/docs
2
+
3
+ `@deot/docs` 是 `@deot/docs` 工具链的聚合包。公共入口导出 `Dever`、`Locale`、`Renderer` 与 `Theme` 命名空间,分别用于文档服务、界面国际化、页面渲染/装修和主题协议。
4
+
5
+ **不包含** Markdown、Playground、Client 或 CLI 的 re-export。使用这些能力请直接安装 [`@deot/docs-markdown`](../markdown/README.md)、[`@deot/docs-playground`](../playground/README.md)、[`@deot/docs-client`](../client/README.md) 或 [`@deot/docs-cli`](../cli/README.md)。
6
+
7
+ ## 安装
8
+
9
+ ```bash
10
+ pnpm add @deot/docs
11
+ ```
12
+
13
+ ## 快速开始
14
+
15
+ ```ts
16
+ import { Dever } from '@deot/docs';
17
+
18
+ const config = Dever.createDeverConfig({
19
+ workspace: 'site'
20
+ });
21
+ ```
22
+
23
+ 也可以直接运行指定模式:
24
+
25
+ ```ts
26
+ import { Dever } from '@deot/docs';
27
+
28
+ await Dever.run({
29
+ workspace: 'site',
30
+ preview: true
31
+ });
32
+ ```
33
+
34
+ `dev` 会启动常驻的 Vite 开发服务;`preview` 使用无 watcher 的静态 HTTP 服务;`build` 完成一次构建后退出。
35
+
36
+ 浏览器侧也可以从同一入口拿到 Renderer:
37
+
38
+ ```ts
39
+ import { Renderer } from '@deot/docs';
40
+
41
+ const { Combo, Renderer: PageRenderer, BuiltinModules } = Renderer;
42
+ ```
43
+
44
+ ## 公共 API
45
+
46
+ | 导出 | 说明 |
47
+ | --- | --- |
48
+ | `Dever.run(options)` | 运行 development、build 或 preview 模式。 |
49
+ | `Dever.createDeverConfig(options)` | 根据当前工作目录和选项生成 Vite 配置。 |
50
+ | `Dever.getDeverMode(options)` | 返回 `development`、`build` 或 `preview`。 |
51
+ | `Dever.resolveDocsWorkspace(cwd?, workspace?)` | 解析项目内的根目录或子目录文档 workspace。 |
52
+ | `Dever.DeverOptions` | `@deot/docs-dever` 提供的运行选项类型。 |
53
+ | `Dever.DeverMode` | 三种运行模式的联合类型。 |
54
+ | `Locale` | `@deot/docs-locale` 的语言包、Translator 与 Vue Provider API。 |
55
+ | `Renderer` | `@deot/docs-renderer` 的 `Combo`、`Renderer`、内置模块与协议工具。 |
56
+ | `Theme` | `@deot/docs-theme` 的主题类型、主题值和校验函数。 |
57
+
58
+ 更完整的选项和运行规则请查看 [`@deot/docs-dever`](../dever/README.md)。页面协议请查看 [`@deot/docs-renderer`](../renderer/README.md)。命令行用法请查看 [`@deot/docs-cli`](../cli/README.md)。
59
+
60
+ ## 仓库内验证
61
+
62
+ 在仓库根目录执行:
63
+
64
+ ```bash
65
+ npm run test -- --package-name index
66
+ npm run build -- --package-name index
67
+ ```
68
+
69
+ ## 许可证
70
+
71
+ MIT
package/dist/index.cjs ADDED
@@ -0,0 +1,55 @@
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
+ //#region \0rolldown/runtime.js
3
+ var __create = Object.create;
4
+ var __defProp = Object.defineProperty;
5
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
6
+ var __getOwnPropNames = Object.getOwnPropertyNames;
7
+ var __getProtoOf = Object.getPrototypeOf;
8
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
9
+ var __copyProps = (to, from, except, desc) => {
10
+ if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
11
+ key = keys[i];
12
+ if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
13
+ get: ((k) => from[k]).bind(null, key),
14
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
15
+ });
16
+ }
17
+ return to;
18
+ };
19
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
20
+ value: mod,
21
+ enumerable: true
22
+ }) : target, mod));
23
+ //#endregion
24
+ let _deot_docs_dever = require("@deot/docs-dever");
25
+ _deot_docs_dever = __toESM(_deot_docs_dever);
26
+ let _deot_docs_locale = require("@deot/docs-locale");
27
+ _deot_docs_locale = __toESM(_deot_docs_locale);
28
+ let _deot_docs_renderer = require("@deot/docs-renderer");
29
+ _deot_docs_renderer = __toESM(_deot_docs_renderer);
30
+ let _deot_docs_theme = require("@deot/docs-theme");
31
+ _deot_docs_theme = __toESM(_deot_docs_theme);
32
+ Object.defineProperty(exports, "Dever", {
33
+ enumerable: true,
34
+ get: function() {
35
+ return _deot_docs_dever;
36
+ }
37
+ });
38
+ Object.defineProperty(exports, "Locale", {
39
+ enumerable: true,
40
+ get: function() {
41
+ return _deot_docs_locale;
42
+ }
43
+ });
44
+ Object.defineProperty(exports, "Renderer", {
45
+ enumerable: true,
46
+ get: function() {
47
+ return _deot_docs_renderer;
48
+ }
49
+ });
50
+ Object.defineProperty(exports, "Theme", {
51
+ enumerable: true,
52
+ get: function() {
53
+ return _deot_docs_theme;
54
+ }
55
+ });
@@ -0,0 +1,14 @@
1
+ import * as Dever from '@deot/docs-dever';
2
+ import * as Locale from '@deot/docs-locale';
3
+ import * as Renderer from '@deot/docs-renderer';
4
+ import * as Theme from '@deot/docs-theme';
5
+
6
+ export { Dever }
7
+
8
+ export { Locale }
9
+
10
+ export { Renderer }
11
+
12
+ export { Theme }
13
+
14
+ export { }
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ import * as Dever from "@deot/docs-dever";
2
+ import * as Locale from "@deot/docs-locale";
3
+ import * as Renderer from "@deot/docs-renderer";
4
+ import * as Theme from "@deot/docs-theme";
5
+ export { Dever, Locale, Renderer, Theme };
package/package.json ADDED
@@ -0,0 +1,23 @@
1
+ {
2
+ "name": "@deot/docs",
3
+ "version": "1.0.1",
4
+ "main": "dist/index.js",
5
+ "types": "dist/index.d.ts",
6
+ "files": [
7
+ "dist"
8
+ ],
9
+ "license": "MIT",
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "dependencies": {
14
+ "@deot/docs-cli": "^1.0.1",
15
+ "@deot/docs-client": "^1.0.1",
16
+ "@deot/docs-dever": "^1.0.1",
17
+ "@deot/docs-locale": "^1.0.1",
18
+ "@deot/docs-markdown": "^1.0.1",
19
+ "@deot/docs-playground": "^1.0.1",
20
+ "@deot/docs-renderer": "^1.0.1",
21
+ "@deot/docs-theme": "^1.0.1"
22
+ }
23
+ }