@runcontext/site 0.3.4 → 0.3.5
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 +3 -41
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,48 +1,10 @@
|
|
|
1
1
|
# @runcontext/site
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## What it does
|
|
6
|
-
|
|
7
|
-
Generates a browsable HTML documentation site from your compiled ContextKit metadata:
|
|
8
|
-
|
|
9
|
-
- **Model pages** — datasets, fields, schema browser, rules, relationships
|
|
10
|
-
- **Glossary** — all business terms with definitions, synonyms, and linked fields
|
|
11
|
-
- **Owner pages** — team ownership with governed models
|
|
12
|
-
- **Search** — full-text search across all entities
|
|
13
|
-
- **Tier badges** — visual Bronze/Silver/Gold status per model
|
|
14
|
-
|
|
15
|
-
## Usage
|
|
16
|
-
|
|
17
|
-
Through the CLI:
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
npx @runcontext/cli build # compile context files first
|
|
21
|
-
npx @runcontext/cli site # generate site/ directory
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Then open `site/index.html` or serve with any static file server:
|
|
3
|
+
> **Deprecated** — Use [`@runcontext/cli`](https://www.npmjs.com/package/@runcontext/cli) instead. The site generator is included in the CLI package.
|
|
25
4
|
|
|
26
5
|
```bash
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
## Programmatic Usage
|
|
31
|
-
|
|
32
|
-
```typescript
|
|
33
|
-
import { generateSite } from '@runcontext/site';
|
|
34
|
-
|
|
35
|
-
await generateSite({
|
|
36
|
-
manifest, // compiled ContextKit manifest
|
|
37
|
-
outputDir: './site',
|
|
38
|
-
config: { base_path: '.' }
|
|
39
|
-
});
|
|
6
|
+
npm install @runcontext/cli
|
|
7
|
+
context build && context site
|
|
40
8
|
```
|
|
41
9
|
|
|
42
|
-
## Part of ContextKit
|
|
43
|
-
|
|
44
10
|
See the [ContextKit repository](https://github.com/erickittelson/ContextKit) for full documentation.
|
|
45
|
-
|
|
46
|
-
## License
|
|
47
|
-
|
|
48
|
-
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@runcontext/site",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.5",
|
|
4
4
|
"description": "Static documentation site generator for ContextKit",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Eric Kittelson",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"dist"
|
|
37
37
|
],
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@runcontext/core": "^0.3.
|
|
39
|
+
"@runcontext/core": "^0.3.5",
|
|
40
40
|
"ejs": "^3.1.10",
|
|
41
41
|
"minisearch": "^7.1.0"
|
|
42
42
|
},
|