@x12i/memorix-docs 1.0.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.
- package/README.md +25 -0
- package/bin/memorix-docs.js +2 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +56 -0
- package/dist/cli.js.map +1 -0
- package/dist/generated/bundle.d.ts +1451 -0
- package/dist/generated/bundle.d.ts.map +1 -0
- package/dist/generated/bundle.js +2702 -0
- package/dist/generated/bundle.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -0
- package/package.json +57 -0
package/README.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# @x12i/memorix-docs
|
|
2
|
+
|
|
3
|
+
Memorix ebook **knowledge SDK**. Install as a **devDependency only** — do not add to production service dependencies.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm i -D @x12i/memorix-docs
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { memorixEbooks } from "@x12i/memorix-docs";
|
|
11
|
+
|
|
12
|
+
memorixEbooks.getUseCaseMarkdown("client-first-read-write");
|
|
13
|
+
memorixEbooks.getBookMarkdown("01-format-for-dummies", "developers");
|
|
14
|
+
memorixEbooks.manifest();
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
CLI:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx memorix-docs list-use-cases
|
|
21
|
+
npx memorix-docs use-case client-first-read-write > pack.md
|
|
22
|
+
npx memorix-docs book 02-runtime-data-client developers > book.md
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Depends on published `@x12i/docify-core` / `@x12i/docify-sdk`. Share the human UI via `@x12i/docify-web` + a content bundle (see parent `memorix-docs/README.md`).
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
|
package/dist/cli.js
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { memorixDocs } from "./index.js";
|
|
3
|
+
const [cmd, id, audience] = process.argv.slice(2);
|
|
4
|
+
function usage() {
|
|
5
|
+
console.error(`Usage:
|
|
6
|
+
memorix-docs use-case <id> Print assembled use-case markdown
|
|
7
|
+
memorix-docs book <id> <audience> Print book markdown
|
|
8
|
+
memorix-docs list-use-cases List use case ids
|
|
9
|
+
memorix-docs list-books List book ids
|
|
10
|
+
`);
|
|
11
|
+
}
|
|
12
|
+
if (!cmd || cmd === "help" || cmd === "--help") {
|
|
13
|
+
usage();
|
|
14
|
+
process.exit(cmd ? 0 : 1);
|
|
15
|
+
}
|
|
16
|
+
if (cmd === "list-use-cases") {
|
|
17
|
+
for (const uc of memorixDocs.listUseCases()) {
|
|
18
|
+
console.log(`${uc.id}\t${uc.title}`);
|
|
19
|
+
}
|
|
20
|
+
process.exit(0);
|
|
21
|
+
}
|
|
22
|
+
if (cmd === "list-books") {
|
|
23
|
+
for (const b of memorixDocs.listBooks()) {
|
|
24
|
+
console.log(`${b.id}\t${b.title}\t${b.audiences.join(",")}`);
|
|
25
|
+
}
|
|
26
|
+
process.exit(0);
|
|
27
|
+
}
|
|
28
|
+
if (cmd === "use-case") {
|
|
29
|
+
if (!id) {
|
|
30
|
+
usage();
|
|
31
|
+
process.exit(1);
|
|
32
|
+
}
|
|
33
|
+
const md = memorixDocs.getUseCaseMarkdown(id);
|
|
34
|
+
if (!md) {
|
|
35
|
+
console.error(`Unknown use case: ${id}`);
|
|
36
|
+
process.exit(1);
|
|
37
|
+
}
|
|
38
|
+
process.stdout.write(md);
|
|
39
|
+
process.exit(0);
|
|
40
|
+
}
|
|
41
|
+
if (cmd === "book") {
|
|
42
|
+
if (!id || !audience) {
|
|
43
|
+
usage();
|
|
44
|
+
process.exit(1);
|
|
45
|
+
}
|
|
46
|
+
const md = memorixDocs.getBookMarkdown(id, audience);
|
|
47
|
+
if (!md) {
|
|
48
|
+
console.error(`Unknown book/audience: ${id} ${audience}`);
|
|
49
|
+
process.exit(1);
|
|
50
|
+
}
|
|
51
|
+
process.stdout.write(md);
|
|
52
|
+
process.exit(0);
|
|
53
|
+
}
|
|
54
|
+
usage();
|
|
55
|
+
process.exit(1);
|
|
56
|
+
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAElD,SAAS,KAAK;IACZ,OAAO,CAAC,KAAK,CAAC;;;;;CAKf,CAAC,CAAC;AACH,CAAC;AAED,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,MAAM,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;IAC/C,KAAK,EAAE,CAAC;IACR,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5B,CAAC;AAED,IAAI,GAAG,KAAK,gBAAgB,EAAE,CAAC;IAC7B,KAAK,MAAM,EAAE,IAAI,WAAW,CAAC,YAAY,EAAE,EAAE,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,YAAY,EAAE,CAAC;IACzB,KAAK,MAAM,CAAC,IAAI,WAAW,CAAC,SAAS,EAAE,EAAE,CAAC;QACxC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,UAAU,EAAE,CAAC;IACvB,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,GAAG,WAAW,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrB,KAAK,EAAE,CAAC;QACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,EAAE,GAAG,WAAW,CAAC,eAAe,CAAC,EAAE,EAAE,QAAqC,CAAC,CAAC;IAClF,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,KAAK,EAAE,CAAC;AACR,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC"}
|