{"_id":"@aiql-org/docgen","name":"@aiql-org/docgen","dist-tags":{"latest":"2.9.0"},"versions":{"2.9.0":{"name":"@aiql-org/docgen","version":"2.9.0","description":"Semantic Documentation Generator for AIQL","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":{"types":"./dist/index.d.ts","default":"./dist/index.js"}}},"scripts":{"build":"tsc","clean":"rm -rf dist","test":"vitest run"},"keywords":["aiql","documentation","generator","semantic"],"author":{"name":"AIQL Contributors"},"license":"MIT","dependencies":{"@aiql-org/core":"^2.9.0"},"devDependencies":{"@types/node":"^20.0.0","typescript":"^5.0.0","vite":"^7.3.1","vitest":"^1.6.1"},"engines":{"node":">=20.0.0"},"_id":"@aiql-org/docgen@2.9.0","gitHead":"12866c47f211ab63f82c911b9d1e805d29ed2864","_nodeVersion":"20.20.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-lo71TfN6z++oQBRU/XGpGVSDkVV5kOKvQrcvII97zBrAlAnRUG/nLh0INsn3vTmEHWgzuwg+CJ+x0GqhcOGwKg==","shasum":"079afb141e4febebdff6e4c6bf18b90adb87d057","tarball":"https://registry.npmjs.org/@aiql-org/docgen/-/docgen-2.9.0.tgz","fileCount":22,"unpackedSize":36291,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQD76OIhZmzNBaW9HUjl2ETZPhHvmyISYmgN/Vht//g9NQIgRqvlHYlMree/dGcnZuu1cabgLKB/+4IRsvuhhKrU0O0="}]},"_npmUser":{"name":"aiql_valsee","email":"info@aiql.org"},"directories":{},"maintainers":[{"name":"aiql_valsee","email":"info@aiql.org"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docgen_2.9.0_1771478740423_0.29202591109074505"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-19T05:25:40.314Z","2.9.0":"2026-02-19T05:25:40.559Z","modified":"2026-02-19T05:25:40.791Z"},"maintainers":[{"name":"aiql_valsee","email":"info@aiql.org"}],"description":"Semantic Documentation Generator for AIQL","keywords":["aiql","documentation","generator","semantic"],"author":{"name":"AIQL Contributors"},"license":"MIT","readme":"# @aiql-org/docgen\n\nSemantic Documentation Generator for AIQL.\nExtracts knowledge graphs, class definitions, rules, and workflows from AIQL code and renders them into beautiful Markdown or JSON.\n\n## Features\n\n- **Knowledge Extraction**: Parses AIQL AST to extract Classes, Concepts, Rules, and Tasks.\n- **Graph Generation**: Automatically builds a Mermaid.js knowledge graph of your ontology.\n- **Markdown Rendering**: Generates human-readable documentation with tables and icons.\n- **Type Safe**: Fully typed with TypeScript.\n\n## Usage\n\n```typescript\nimport { Tokenizer, Parser } from '@aiql-org/core';\nimport { DocExtractor, MarkdownRenderer } from '@aiql-org/docgen';\n\nconst code = `\n!DefineClass(name:Agent) {\n  <Agent> [has_capability] <Reasoning>\n}\n`;\n\n// 1. Parse AIQL\nconst tokenizer = new Tokenizer(code);\nconst parser = new Parser(tokenizer.tokenize());\nconst ast = parser.parse();\n\n// 2. Extract Documentation Model\nconst extractor = new DocExtractor();\nconst doc = extractor.extract(ast, 'My Agent System');\n\n// 3. Render to Markdown\nconst renderer = new MarkdownRenderer();\nconst markdown = renderer.render(doc);\n\nconsole.log(markdown);\n```\n","readmeFilename":"README.md","_rev":"1-8bfaf2f2d8b231ee23e4073a53e27885"}