{"_id":"@aewerdev/dokujs","_rev":"4-f4fef793713c4575c5a5fad3c4a8c94f","name":"@aewerdev/dokujs","dist-tags":{"latest":"0.1.3"},"versions":{"0.1.0":{"name":"@aewerdev/dokujs","version":"0.1.0","keywords":["doku","documentation","markdown","compiler","static-site"],"author":"","license":"Apache-2.0","_id":"@aewerdev/dokujs@0.1.0","maintainers":[{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"}],"homepage":"https://github.com/your-org/dokujs#readme","bugs":{"url":"https://github.com/your-org/dokujs/issues"},"bin":{"doku":"bin/doku.js","doku-new":"bin/doku-new.js","doku-build":"bin/doku-build.js","doku-compile":"bin/doku-compile.js"},"dist":{"shasum":"880aa5dbebff23dc61a5523a012bed1563900af7","tarball":"https://registry.npmjs.org/@aewerdev/dokujs/-/dokujs-0.1.0.tgz","fileCount":11,"integrity":"sha512-OcOpCX09YvI31oiWI86XQufgs70TjnaM3toCX+hKjEOafilnobn8BIqlstybpVuWlxmA5KaoOQQpNckQ2+8t2Q==","signatures":[{"sig":"MEQCICwqe3OCJ950SxYblDp1dsUGVuZEiOmM1u2MXmAJ2Z0IAiB3qwJKA1DZya9ydrhHThWrcWaK+zsen7hJHp78OJQZOg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":51165},"main":"lib/compiler.js","type":"module","engines":{"node":">=18"},"exports":{".":"./lib/compiler.js","./browser/dokujs.js":"./dokujs.js"},"scripts":{"lint":"node --version","test":"node -e \"console.log('dokujs ready')\"","build":"echo 'No build step needed'","prepublishOnly":"npm run test && npm pack --dry-run"},"_npmUser":{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"},"repository":{"url":"git+https://github.com/your-org/dokujs.git","type":"git"},"_npmVersion":"11.4.2","description":"Doku (.doku) compiler, builder and browser runtime for documentation, guides and books.","directories":{},"_nodeVersion":"24.4.1","dependencies":{"toml":"^3.0.0","marked":"^12.0.2","nanoid":"^5.0.7","adm-zip":"^0.5.12","js-yaml":"^4.1.0","gray-matter":"^4.0.3","highlight.js":"^11.9.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/dokujs_0.1.0_1757833498429_0.9427685265145123","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@aewerdev/dokujs","version":"0.1.1","keywords":["doku","documentation","markdown","compiler","static-site"],"author":"","license":"Apache-2.0","_id":"@aewerdev/dokujs@0.1.1","maintainers":[{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"}],"homepage":"https://github.com/your-org/dokujs#readme","bugs":{"url":"https://github.com/your-org/dokujs/issues"},"bin":{"doku":"bin/doku.js","doku-new":"bin/doku-new.js","doku-build":"bin/doku-build.js","doku-compile":"bin/doku-compile.js"},"dist":{"shasum":"78d3626e2611ca05cec5d85bcd010ef571493b14","tarball":"https://registry.npmjs.org/@aewerdev/dokujs/-/dokujs-0.1.1.tgz","fileCount":11,"integrity":"sha512-wHtWV+kLJQUy0fI2Z7tnmI/J1n/GEIvNcwYvzqE9k3laYtiUd6KKsk2NcB4POe+2j8loIWVcvUAckctzqMdX1g==","signatures":[{"sig":"MEUCIQCnxY6C2+YqsjY+Mg2J8wdthgYjmChP9S+ffLHwYteiLAIgCQGKDcwsF7KwchDDHdIKXqmPJle+Z3BEYohL/uNVgOI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":51189},"main":"lib/compiler.js","type":"module","engines":{"node":">=18"},"exports":{".":"./lib/compiler.js","./browser/dokujs.js":"./dokujs.js"},"scripts":{"lint":"node --version","test":"node -e \"console.log('dokujs ready')\"","build":"echo 'No build step needed'","prepublishOnly":"npm run test && npm pack --dry-run"},"_npmUser":{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"},"repository":{"url":"git+https://github.com/your-org/dokujs.git","type":"git"},"_npmVersion":"11.4.2","description":"Doku (.doku) compiler, builder and browser runtime for documentation, guides and books.","directories":{},"_nodeVersion":"24.4.1","dependencies":{"toml":"^3.0.0","marked":"^12.0.2","nanoid":"^5.0.7","adm-zip":"^0.5.12","js-yaml":"^4.1.0","gray-matter":"^4.0.3","highlight.js":"^11.9.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/dokujs_0.1.1_1757834067371_0.44538539251754616","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@aewerdev/dokujs","version":"0.1.2","keywords":["doku","documentation","markdown","compiler","static-site"],"author":"","license":"Apache-2.0","_id":"@aewerdev/dokujs@0.1.2","maintainers":[{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"}],"homepage":"https://github.com/your-org/dokujs#readme","bugs":{"url":"https://github.com/your-org/dokujs/issues"},"bin":{"doku":"bin/doku.js","doku-new":"bin/doku-new.js","doku-build":"bin/doku-build.js","doku-compile":"bin/doku-compile.js"},"dist":{"shasum":"9837c7f5d267a145250d751a260dd2b0e4e1b94d","tarball":"https://registry.npmjs.org/@aewerdev/dokujs/-/dokujs-0.1.2.tgz","fileCount":11,"integrity":"sha512-5oyWHgqB1UDHknNp1BUjU8Xkp/+ULmaB2fIXXeCgCm10pyVCzpJzKiokEcOGTA9ZaoGlJh6edv0mHfZyHZonbQ==","signatures":[{"sig":"MEQCIAagDZPkaLL61ZsyO5BybSPiTF6xK8MQ1H8VN1rfqLgBAiAhd8KzLWqvRnC++axqxqwCwWVsRFCM1Gt2JscgSvBuRg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":51189},"main":"lib/compiler.js","type":"module","engines":{"node":">=18"},"exports":{".":"./lib/compiler.js","./browser/dokujs.js":"./dokujs.js"},"scripts":{"lint":"node --version","test":"node -e \"console.log('dokujs ready')\"","build":"echo 'No build step needed'","prepublishOnly":"npm run test && npm pack --dry-run"},"_npmUser":{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"},"repository":{"url":"git+https://github.com/your-org/dokujs.git","type":"git"},"_npmVersion":"11.4.2","description":"Doku (.doku) compiler, builder and browser runtime for documentation, guides and books.","directories":{},"_nodeVersion":"24.4.1","dependencies":{"toml":"^3.0.0","marked":"^12.0.2","nanoid":"^5.0.7","adm-zip":"^0.5.12","js-yaml":"^4.1.0","gray-matter":"^4.0.3","highlight.js":"^11.9.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/dokujs_0.1.2_1757834264828_0.23560513559344165","host":"s3://npm-registry-packages-npm-production"}},"0.1.3":{"name":"@aewerdev/dokujs","version":"0.1.3","description":"Doku (.doku) compiler, builder and browser runtime for documentation, guides and books.","type":"module","main":"lib/compiler.js","exports":{".":"./lib/compiler.js","./browser/dokujs.js":"./dokujs.js"},"repository":{"type":"git","url":"git+https://github.com/your-org/dokujs.git"},"bugs":{"url":"https://github.com/your-org/dokujs/issues"},"homepage":"https://github.com/your-org/dokujs#readme","bin":{"doku":"bin/doku.js","doku-compile":"bin/doku-compile.js","doku-build":"bin/doku-build.js","doku-new":"bin/doku-new.js"},"scripts":{"build":"echo 'No build step needed'","lint":"node --version","test":"node -e \"console.log('dokujs ready')\"","prepublishOnly":"npm run test && npm pack --dry-run"},"keywords":["doku","documentation","markdown","compiler","static-site"],"author":"","license":"Apache-2.0","engines":{"node":">=18"},"publishConfig":{"access":"public"},"dependencies":{"gray-matter":"^4.0.3","js-yaml":"^4.1.0","marked":"^12.0.2","toml":"^3.0.0","nanoid":"^5.0.7","highlight.js":"^11.9.0","adm-zip":"^0.5.12"},"_id":"@aewerdev/dokujs@0.1.3","_nodeVersion":"24.4.1","_npmVersion":"11.4.2","dist":{"integrity":"sha512-L5xpRHdwqqrcmt/ZZUZTy835jy3vC8KI+OqGYERW6GyeUVgUePAFaaWQhHOF1ZnmJCyl1cN6qGxUOylPTc3vlA==","shasum":"5464dbc471dc57963a1af82306932ac14c5bac49","tarball":"https://registry.npmjs.org/@aewerdev/dokujs/-/dokujs-0.1.3.tgz","fileCount":11,"unpackedSize":50841,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQCYnqpVBFPleXHbwCLcAD/U3md1StC5ciYiMSrPPQH0JQIgM/l9ouCqnSBgFWQQMEJ8ei5wLjgyvyvm1x4VF9lExkg="}]},"_npmUser":{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"},"directories":{},"maintainers":[{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/dokujs_0.1.3_1757835366195_0.8022927919965348"},"_hasShrinkwrap":false}},"time":{"created":"2025-09-14T07:04:58.299Z","modified":"2025-09-14T07:36:06.571Z","0.1.0":"2025-09-14T07:04:58.617Z","0.1.1":"2025-09-14T07:14:27.579Z","0.1.2":"2025-09-14T07:17:45.005Z","0.1.3":"2025-09-14T07:36:06.372Z"},"bugs":{"url":"https://github.com/your-org/dokujs/issues"},"license":"Apache-2.0","homepage":"https://github.com/your-org/dokujs#readme","keywords":["doku","documentation","markdown","compiler","static-site"],"repository":{"type":"git","url":"git+https://github.com/your-org/dokujs.git"},"description":"Doku (.doku) compiler, builder and browser runtime for documentation, guides and books.","maintainers":[{"name":"aewerdev","email":"d.pivovarov2019@gmail.com"}],"readme":"# Doku (.doku)\n\nDoku is a simple documentation format and toolchain for building online docs, guides, and books.\n\n- Write content in `.doku` files (Markdown + optional frontmatter in YAML `---` or TOML `+++`).\n- Use the browser runtime to embed a doc: `<script src=\"/path/to/dokujs.js\"></script>` then `<doku src=\"/docs/intro.doku\"></doku>`.\n- Use the CLI to compile files or build full projects.\n\n## Install\n\nUse your preferred package manager:\n\n```bash\n# npm\nnpm install -D dokujs\n\n# pnpm\npnpm add -D dokujs\n\n# yarn\nyarn add -D dokujs\n```\n\n## CLI\n\nUnified command `doku` with subcommands:\n\n```bash\n# Create project\nnpx doku new my-docs\n\n# Build (HTML site)\nnpx doku build my-docs --format=html\n\n# Build (Doku client output: emits .doku pages + client index)\nnpx doku build my-docs --format=doku\n\n# Compile a single .doku to HTML\nnpx doku compile path/to/file.doku path/to/output.html\n```\n\nLegacy binaries (still available): `doku-new`, `doku-build`, `doku-compile`.\n\n## Project Structure\n\n```\nmy-doku/\n  doku.toml\n  version.yaml\n  config.json\n  index.html\n  src/\n    result.yaml\n    assets/\n      logo.svg\n    intro.md\n    intro.ru.md\n    chapter1.md\n    chapter1.ru.md\n  res/\n    index_<buildid>.html\n    index_<buildid>.js\n    assets/\n      ... (copied from src/assets)\n    assets-manifest.json\n```\n\n## Browser Usage\n\n```html\n<script src=\"/path/to/dokujs.js\"></script>\n<doku src=\"/docs/intro.doku\"></doku>\n```\n\n## Features\n\n- i18n: `languages` and language-specific `nav` in `src/result.yaml`. The built site includes a language dropdown and persists selection.\n- Theming: theme colors (`theme.primary`, `theme.accent`), dark/light theme toggle with highlight.js theme switching.\n- Code highlighting: highlight.js via Marked; works server-side (build) and client-side (runtime).\n- Icons & UI: Font Awesome + W3CSS + W3JS included in generated HTML.\n- Assets & Logo:\n  - Put static files under `src/assets/`. They are copied unmodified to `res/assets/` on build.\n  - A manifest `res/assets-manifest.json` maps each relative asset path to a unique `id` (for stable references).\n  - Set a header logo via `logo: assets/logo.svg` in `src/result.yaml`.\n\n### result.yaml (example)\n\n```yaml\ntitle: My Docs\nrepo: https://github.com/your/repo\nauthor:\n  name: Your Name\n  url: https://example.com\n  avatar: https://...\ntheme:\n  primary: \"#0f62fe\"\n  accent: \"#f1c21b\"\nlogo: assets/logo.svg\nlanguages:\n  - code: en\n    label: English\n  - code: ru\n    label: Русский\nsocials:\n  - icon: github\n    url: https://github.com/your\nnav:\n  en:\n    - text: Introduction\n      file: intro.md\n  ru:\n    - text: Введение\n      file: intro.ru.md\n```\n","readmeFilename":"README.md"}