{"_id":"@adityaparab/md2html","_rev":"2-b1eab77bff9a2cd9dc1b92eda5cf5139","name":"@adityaparab/md2html","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@adityaparab/md2html","version":"0.0.1","keywords":["markdown","markdown-viewer","documentation","cli","nestjs","dark-mode"],"author":"","license":"MIT","_id":"@adityaparab/md2html@0.0.1","maintainers":[{"name":"adihimself","email":"mradityaparab@gmail.com"}],"bin":{"md2html":"dist/main.js"},"dist":{"shasum":"ec8c5ddf89bc395119822c236497511c9d8a767c","tarball":"https://registry.npmjs.org/@adityaparab/md2html/-/md2html-0.0.1.tgz","fileCount":30,"integrity":"sha512-KynB9R+zuUT0a0+IsYb562/xqE/GJeZX3mJsN+PTe2fz9ijfQ8fwKDFezd83v719PkVE3R4PJKVB7VcEI6acYg==","signatures":[{"sig":"MEYCIQCy0oH4HrmpfVoZRyYnGpDfTenAirm5f0Evg7mscR0afAIhAMruwF88JXdd3yqsmOMySVSfUicasbvjjJuOKF3ih1hi","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":115405},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=22.0.0"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./package.json":"./package.json"},"gitHead":"2035d1a95048c899b979808fe9826215654b530f","scripts":{"lint":"oxlint src/ test/","test":"vitest run","build":"nest build","check":"npm run verify","start":"nest start","format":"prettier --write \"src/**/*.{ts,js,css,html}\" \"test/**/*.ts\"","verify":"nest build && oxlint src/ test/ && vitest run && vitest run --config ./vitest.config.e2e.ts","prepack":"npm run build","test:cov":"vitest run --coverage","test:e2e":"vitest run --config ./vitest.config.e2e.ts","start:dev":"nest start --watch","start:prod":"node dist/main.js","test:debug":"vitest --inspect-brk --no-file-parallelism","test:watch":"vitest","start:debug":"nest start --debug --watch","prepublishOnly":"npm run verify"},"_npmUser":{"name":"adihimself","email":"mradityaparab@gmail.com"},"_npmVersion":"11.16.0","description":"A beautiful, responsive local Markdown browser powered by NestJS. Run it in any folder to explore your docs.","directories":{},"_nodeVersion":"24.18.0","dependencies":{"rxjs":"^7.8.1","@types/node":"^24.0.0","markdown-it":"^15.0.1","@nestjs/core":"^12.0.1","highlight.js":"^11.12.0","@nestjs/common":"^12.0.1","@types/express":"^5.0.0","reflect-metadata":"^0.2.2","markdown-it-task-lists":"^2.1.1","@nestjs/platform-express":"^12.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"oxlint":"^1.58.0","vitest":"^4.1.2","prettier":"^3.4.2","supertest":"^7.0.0","typescript":"^6.0.2","@nestjs/cli":"^12.0.0","@nestjs/mau":"^0.2.6","@nestjs/testing":"^12.0.1","@types/supertest":"^7.0.0","@nestjs/schematics":"^12.0.0","source-map-support":"^0.5.21","@vitest/coverage-v8":"^4.1.2"},"_npmOperationalInternal":{"tmp":"tmp/md2html_0.0.1_1788785795257_0.4388653513616163","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"@adityaparab/md2html","version":"0.0.2","description":"A beautiful, responsive local Markdown browser powered by NestJS. Run it in any folder to explore your docs.","author":"","license":"MIT","type":"module","main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"},"./package.json":"./package.json"},"bin":{"md2html":"dist/main.js"},"engines":{"node":">=22.0.0"},"keywords":["markdown","markdown-viewer","documentation","cli","nestjs","dark-mode"],"publishConfig":{"access":"public"},"scripts":{"build":"nest build","format":"prettier --write \"src/**/*.{ts,js,css,html}\" \"test/**/*.ts\"","start":"nest start","start:dev":"nest start --watch","start:debug":"nest start --debug --watch","start:prod":"node dist/main.js","lint":"oxlint src/ test/","test":"vitest run","test:watch":"vitest","test:cov":"vitest run --coverage","test:debug":"vitest --inspect-brk --no-file-parallelism","test:e2e":"vitest run --config ./vitest.config.e2e.ts","verify":"nest build && oxlint src/ test/ && vitest run && vitest run --config ./vitest.config.e2e.ts","check":"npm run verify","prepack":"npm run build","prepublishOnly":"npm run verify"},"dependencies":{"@nestjs/common":"^12.0.1","@nestjs/core":"^12.0.1","@nestjs/platform-express":"^12.0.1","@types/express":"^5.0.0","@types/node":"^24.0.0","highlight.js":"^11.12.0","markdown-it":"^15.0.1","markdown-it-task-lists":"^2.1.1","reflect-metadata":"^0.2.2","rxjs":"^7.8.1"},"devDependencies":{"@nestjs/cli":"^12.0.0","@nestjs/mau":"^0.2.6","@nestjs/schematics":"^12.0.0","@nestjs/testing":"^12.0.1","@types/supertest":"^7.0.0","@vitest/coverage-v8":"^4.1.2","oxlint":"^1.58.0","prettier":"^3.4.2","source-map-support":"^0.5.21","supertest":"^7.0.0","typescript":"^6.0.2","vitest":"^4.1.2"},"gitHead":"153f06c67deafb5f0448b5cbf7141121f6085fea","_id":"@adityaparab/md2html@0.0.2","_nodeVersion":"24.18.0","_npmVersion":"11.16.0","dist":{"integrity":"sha512-HaQhqvgeGmlvnjjnXftHyRPMx7iXk/Xw2etUKIqHL9Fm0kovhzsAqQhwUX8NPFda1RTl0+f3SSl44bg48aHAag==","shasum":"6eafb0d72d2e7a695dccaa47ebf2afb64d1de859","tarball":"https://registry.npmjs.org/@adityaparab/md2html/-/md2html-0.0.2.tgz","fileCount":30,"unpackedSize":115644,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIGVAF25bX0sQcFUKCOout4NVi6wgmI6INiVDRISPy1fjAiEAmt2NHmUOcV0vA/ZlvQXHGn8FqYKUUWUs5RQR69J+uM4="}]},"_npmUser":{"name":"adihimself","email":"mradityaparab@gmail.com"},"directories":{},"maintainers":[{"name":"adihimself","email":"mradityaparab@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/md2html_0.0.2_1788786728178_0.7713150140295848"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-07T12:56:35.042Z","modified":"2026-09-07T13:12:08.445Z","0.0.1":"2026-09-07T12:56:35.399Z","0.0.2":"2026-09-07T13:12:08.311Z"},"license":"MIT","keywords":["markdown","markdown-viewer","documentation","cli","nestjs","dark-mode"],"description":"A beautiful, responsive local Markdown browser powered by NestJS. Run it in any folder to explore your docs.","maintainers":[{"name":"adihimself","email":"mradityaparab@gmail.com"}],"readme":"# Your Markdown, beautifully readable.\n\nA quiet, considered space for your documentation. **md2html** turns a folder of Markdown files into a beautiful, searchable reading experience — right on your machine.\n\n> Your files stay yours. No uploads, no accounts, no configuration. Just open a folder and start reading.\n\n## Get started\n\nOnce the package is published, run it from any folder with Node.js 22 or later:\n\n```bash\nnpx @adityaparab/md2html\n```\n\nOpen **http://127.0.0.1:3000** and make yourself at home. Your current directory becomes the root of the file tree, and every Markdown document has a place. To read on another device on the same network, use your computer's LAN IP with port `3000`.\n\nFor development before the first release:\n\n```bash\nyarn install\nyarn build\nnode dist/main.js\n```\n\n## A little less friction\n\n- **See the whole picture.** Explore nested folders in a clean, searchable file tree.\n- **Read comfortably.** Thoughtful typography, highlighted code, and responsive layouts.\n- **Follow your system.** Light and dark themes adapt to your device, with a manual override whenever you want.\n- **Stay in the flow.** Jump between headings, follow local Markdown links, and copy code with a click.\n- **Keep it current.** Edit your files in any editor. The browser picks up changes automatically.\n\n## Make it your own\n\nPoint md2html at a specific folder, choose a port, or leave out directories you don't need.\n\n```bash\nmd2html ./docs --port 4000\nmd2html . --ignore build --ignore vendor\n```\n\n| Option | What it does | Default |\n| --- | --- | --- |\n| `[directory]` | Choose the folder to browse | Current directory |\n| `--port`, `-p` | Set the listening port | `3000` |\n| `--host` | Set the network bind address | `0.0.0.0` |\n| `--ignore` | Skip a directory name at any depth; repeatable | `.git`, `node_modules` |\n| `--all` | Include the default ignored directories | Off |\n\nSee [configuration](docs/configuration.md) for all the details, including access from another device.\n\n## Built for real documents\n\nHeadings, tables, checklists, blockquotes, images, and fenced code all get room to breathe. Local links resolve from the document you're reading, so your documentation works the way you wrote it.\n\nExplore the [Markdown guide](docs/markdown-guide.md) to see what's supported, or read [getting started](docs/getting-started.md) for installation and keyboard shortcuts.\n\n## Use it in your code\n\nThe package also exports a small, typed JavaScript API backed by NestJS.\n\n```ts\nimport { serve } from '@adityaparab/md2html';\n\nconst app = await serve({\n  root: './docs',\n  port: 3000,\n});\n\n// When you're finished:\nawait app.close();\n```\n\nUse `createMarkdownServer(options)` to create an initialized NestJS application without starting a listener, then call `app.listen(port, host)` yourself. Both functions accept `root`, `port`, `host`, and `ignore`. For `createMarkdownServer`, `port` and `host` are used only by `serve`; pass them to `app.listen` when managing the listener yourself.\n\n## Developing & publishing\n\n```bash\nyarn verify      # Build, lint, unit tests, and HTTP integration tests\nnpm pack         # Build an installable tarball including the frontend\n```\n\nUse `yarn verify` (or `npm run verify`) to run the project checks. In Yarn Classic,\n`yarn check` is a built-in dependency checker; `yarn run check` remains available\nas an alias for the project's verification script.\n\nThe package name is **@adityaparab/md2html**; the CLI command is **md2html**. See the [publishing guide](docs/publishing.md) for a release walkthrough.\n\n## License\n\nReleased under the **MIT License**. Copyright (c) 2026 Aditya Parab. See the included `LICENSE` file for the full terms.\n\nThe software is provided \"as is\", without warranty. Support and maintenance are voluntary, with no guaranteed updates, fixes, or response times.\n\n---\n\nBuilt with NestJS, markdown-it, and highlight.js. Designed to give your words a little more clarity.\n","readmeFilename":"README.md"}