{"_id":"@congcongcai/doc-on-repository","_rev":"3-6e166e458294a382fed490365615af59","name":"@congcongcai/doc-on-repository","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.0":{"name":"@congcongcai/doc-on-repository","version":"0.0.0","keywords":[],"author":{"name":"CongcongCai"},"license":"MPL-2.0","_id":"@congcongcai/doc-on-repository@0.0.0","maintainers":[{"name":"congcongcai","email":"congcongcai0907@163.com"}],"homepage":"https://github.com/HerrCai0907/doc-on-repository#readme","bugs":{"url":"https://github.com/HerrCai0907/doc-on-repository/issues"},"dist":{"shasum":"34ecc3b85b4c98a07aef951e4992b3308d6cc654","tarball":"https://registry.npmjs.org/@congcongcai/doc-on-repository/-/doc-on-repository-0.0.0.tgz","fileCount":10,"integrity":"sha512-qwO883pRHMWxABQNZwP4jUEYv/SZSzOx276VicJqnbRcFsnzOcYByswiJQYHy2JzX1s7tZuxLpCJ8T16wFY0nw==","signatures":[{"sig":"MEUCIF4VjjfXcM4AZK4gMdcCHSCOSjKflsQLTJvRGPKQ9zASAiEAvRh6J8CAptZuRht8ogZlQ510g7AdBFONNyu/VnV5xuQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":35452},"main":"dist/index.js","type":"module","gitHead":"98d8c0141eb9e02fe413b59322cfe6a8b6c5c8cd","scripts":{"dev":"nodemon --watch 'dist/**/*' --exec 'node dist/index.js'","build":"tsc","start":"node dist/index.js","watch":"tsc -w"},"_npmUser":{"name":"congcongcai","email":"congcongcai0907@163.com"},"repository":{"url":"git+https://github.com/HerrCai0907/doc-on-repository.git","type":"git"},"_npmVersion":"10.8.1","description":"Use multiple formats to write and manage documents in a git-managed repository","directories":{},"_nodeVersion":"22.3.0","dependencies":{"chalk":"^5.4.1","marked":"^15.0.7","express":"^4.21.2","commander":"^13.1.0","reveal.js":"^5.1.0","typescript":"^5.7.3","@types/node":"^22.13.4","@types/express":"^5.0.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"nodemon":"^3.1.9","prettier":"^3.5.1"},"_npmOperationalInternal":{"tmp":"tmp/doc-on-repository_0.0.0_1739806913121_0.24718975395781495","host":"s3://npm-registry-packages-npm-production"}},"0.0.1":{"name":"@congcongcai/doc-on-repository","version":"0.0.1","keywords":[],"author":{"name":"CongcongCai"},"license":"MPL-2.0","_id":"@congcongcai/doc-on-repository@0.0.1","maintainers":[{"name":"congcongcai","email":"congcongcai0907@163.com"}],"homepage":"https://github.com/HerrCai0907/doc-on-repository#readme","bugs":{"url":"https://github.com/HerrCai0907/doc-on-repository/issues"},"dist":{"shasum":"d1ba8d141f5fc5921e90ad903083a31347304c12","tarball":"https://registry.npmjs.org/@congcongcai/doc-on-repository/-/doc-on-repository-0.0.1.tgz","fileCount":10,"integrity":"sha512-4Zbc/VUiRBvcdGnpWKV2mZfi3y7O5l5tmIPads+MZii0aiwU5MWILFHKEL76ZFBjzhje7SCp0ReQ126TOYYKbw==","signatures":[{"sig":"MEQCIDnHZOwm3wi6xcCnxb5/uCNlIye/AZo/RMVTsm7wCvULAiAj72ocEH+ZN/cccWA9KxpCIIYaWZpNrLJ60cGyHQbf4w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":35452},"main":"dist/index.js","type":"module","gitHead":"f448d3851b1be05f000f465b85e1ddc6e2055d10","scripts":{"dev":"nodemon --watch 'dist/**/*' --exec 'node dist/index.js'","build":"tsc","start":"node dist/index.js","watch":"tsc -w"},"_npmUser":{"name":"congcongcai","email":"congcongcai0907@163.com"},"repository":{"url":"git+https://github.com/HerrCai0907/doc-on-repository.git","type":"git"},"_npmVersion":"10.8.2","description":"Use multiple formats to write and manage documents in a git-managed repository","directories":{},"_nodeVersion":"20.18.2","dependencies":{"chalk":"^5.4.1","marked":"^15.0.7","express":"^4.21.2","commander":"^13.1.0","reveal.js":"^5.1.0","typescript":"^5.7.3","@types/node":"^22.13.4","@types/express":"^5.0.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"nodemon":"^3.1.9","prettier":"^3.5.1"},"_npmOperationalInternal":{"tmp":"tmp/doc-on-repository_0.0.1_1739807020617_0.8136659907181558","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@congcongcai/doc-on-repository","version":"0.0.2","keywords":[],"author":{"name":"CongcongCai"},"license":"MPL-2.0","_id":"@congcongcai/doc-on-repository@0.0.2","maintainers":[{"name":"congcongcai","email":"congcongcai0907@163.com"}],"homepage":"https://github.com/HerrCai0907/doc-on-repository#readme","bugs":{"url":"https://github.com/HerrCai0907/doc-on-repository/issues"},"bin":{"doc_on_repository_server":"dist/index.js"},"dist":{"shasum":"f175c564fba0496d68a835d228be788998447371","tarball":"https://registry.npmjs.org/@congcongcai/doc-on-repository/-/doc-on-repository-0.0.2.tgz","fileCount":10,"integrity":"sha512-Jj53vENPvYJpVcDZTuVM+EA01EbB2Y4qpVUrNJXDZT0QetPPd/QG+SPJKsPh6630FQBlfQJ/gcD1ubdW5QtWSA==","signatures":[{"sig":"MEQCIFjsnvsfDzQlOEb6kNtFNqzyVjlq9ZSHyoZyuZXKQJx8AiBBMyPb7cwprkyXierEcodMjK1xKi26YjY8+1c7KDeckg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":35547},"main":"dist/index.js","type":"module","gitHead":"220adfb023ef45109bf98a44f3d825953bb50a47","scripts":{"dev":"nodemon --watch 'dist/**/*' --exec 'node dist/index.js'","build":"tsc","start":"node dist/index.js","watch":"tsc -w"},"_npmUser":{"name":"congcongcai","email":"congcongcai0907@163.com"},"repository":{"url":"git+https://github.com/HerrCai0907/doc-on-repository.git","type":"git"},"_npmVersion":"10.8.2","description":"Use multiple formats to write and manage documents in a git-managed repository","directories":{},"_nodeVersion":"20.18.2","dependencies":{"chalk":"^5.4.1","marked":"^15.0.7","express":"^4.21.2","commander":"^13.1.0","reveal.js":"^5.1.0","typescript":"^5.7.3","@types/node":"^22.13.4","@types/express":"^5.0.0"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"devDependencies":{"nodemon":"^3.1.9","prettier":"^3.5.1"},"_npmOperationalInternal":{"tmp":"tmp/doc-on-repository_0.0.2_1739863101094_0.3133266257356824","host":"s3://npm-registry-packages-npm-production"}},"0.0.3":{"name":"@congcongcai/doc-on-repository","version":"0.0.3","description":"Use multiple formats to write and manage documents in a git-managed repository","bin":{"doc_on_repository_server":"dist/server/index.js"},"type":"module","scripts":{"build":"tsc -p src && tsc -p web","watch":"concurrently \"tsc -w -p src\" \"tsc -w -p web\"","start":"node dist/server/index.js --root demo","dev":"nodemon --watch 'dist/**/*' --exec 'npm start'"},"dependencies":{"@types/express":"^5.0.0","@types/node":"^22.13.4","chalk":"^5.4.1","commander":"^13.1.0","express":"^4.21.2","markdown-it":"^14.1.0","reveal.js":"^5.1.0","typescript":"^5.7.3"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"repository":{"type":"git","url":"git+https://github.com/HerrCai0907/doc-on-repository.git"},"keywords":[],"author":{"name":"CongcongCai"},"license":"MPL-2.0","devDependencies":{"@types/markdown-it":"^14.1.2","concurrently":"^9.1.2","nodemon":"^3.1.9","prettier":"^3.5.1"},"_id":"@congcongcai/doc-on-repository@0.0.3","gitHead":"f520877b4628681736bc8aa3115823c2452842cd","bugs":{"url":"https://github.com/HerrCai0907/doc-on-repository/issues"},"homepage":"https://github.com/HerrCai0907/doc-on-repository#readme","_nodeVersion":"20.18.2","_npmVersion":"10.8.2","dist":{"integrity":"sha512-WlM3NENwW16yPQZK8ewkZMgRwBN38Ca5xrwIILBgzoonAfX77v7iSAqBhz6TjrA3nuy0wNv37+f8aQujlmOHdw==","shasum":"377dc1e1129f9afe9eb901b8d4b5a1b1e3c93cb2","tarball":"https://registry.npmjs.org/@congcongcai/doc-on-repository/-/doc-on-repository-0.0.3.tgz","fileCount":13,"unpackedSize":38968,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIA7NdC+/MwEmEWUOKNKwx4f9ZZFXeNs4nFUqVlI/vmCCAiEAxrz6vyEqml2bxC9c+5+G3CFf4BHTG4uwakhX3y42AyM="}]},"_npmUser":{"name":"congcongcai","email":"congcongcai0907@163.com"},"directories":{},"maintainers":[{"name":"congcongcai","email":"congcongcai0907@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/doc-on-repository_0.0.3_1740102877912_0.7405332037640757"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-17T15:41:52.737Z","modified":"2025-02-21T01:54:38.267Z","0.0.0":"2025-02-17T15:41:53.319Z","0.0.1":"2025-02-17T15:43:40.886Z","0.0.2":"2025-02-18T07:18:21.253Z","0.0.3":"2025-02-21T01:54:38.093Z"},"bugs":{"url":"https://github.com/HerrCai0907/doc-on-repository/issues"},"author":{"name":"CongcongCai"},"license":"MPL-2.0","homepage":"https://github.com/HerrCai0907/doc-on-repository#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/HerrCai0907/doc-on-repository.git"},"description":"Use multiple formats to write and manage documents in a git-managed repository","maintainers":[{"name":"congcongcai","email":"congcongcai0907@163.com"}],"readme":"# documents on repository\n\nThis app want to help developer using multiple formats to write and manage documents in a git-managed repository\nIt is helpful to prevent inconsistencies between code and documentation and give AI tooling more hint.\n\n[document](doc/index.md)\n\n## Key Feature\n\n- Render\n  - [x] create index page automatically\n  - [x] render markdown (by [markdown-it](https://github.com/markdown-it/markdown-it))\n  - [x] render ppt (by [reveal.js](https://revealjs.com/))\n  - [ ] render mermaid charting\n  - [ ] render draw.io\n- Real-Time\n  - [x] sync file change to html\n  - [ ] allow edit in html\n\n## Usage\n\nTo run the application, use the following command:\n\n```bash\nnpm start\n```\n\n```bash\nUsage: index [options]\n\nOptions:\n  -p, --port <number>  port number (default: \"3000\")\n  --root <folder>      document folder (default: \"doc\")\n  -h, --help           display help for command\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\n\n## License\n\nThis project is licensed under the MPL-2.0 License. See the LICENSE file for more details.\n","readmeFilename":"README.md"}