{"_id":"@atomisadev/notesmd","_rev":"2-716761a920de6110168f62298d5ed2f9","name":"@atomisadev/notesmd","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@atomisadev/notesmd","version":"1.0.0","_id":"@atomisadev/notesmd@1.0.0","maintainers":[{"name":"atomisadev","email":"atomdevelops@protonmail.com"}],"bin":{"notes":"src/index.ts"},"dist":{"shasum":"9208403604eacccdbdf29e98f5fba3cf0ed630ad","tarball":"https://registry.npmjs.org/@atomisadev/notesmd/-/notesmd-1.0.0.tgz","fileCount":19,"integrity":"sha512-SVC2Ix+ivDW9Pz6fZd1tlZrhv92s06mOrGGMLDS10Zb4tBwrF23TQ1aGn7Nx1zB96xx1l0nAnhH+hnpMug7/8w==","signatures":[{"sig":"MEUCIQDG8QY7xo9yE2Eb1ErvYuUe6B0gRwl/SCUvbyQ4TW41KwIgUSPD+ve4YBtjJQD9fLCnNRlOrdfqvqWtSMJjoY/FkRU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":32998},"type":"module","module":"src/index.ts","gitHead":"3406de90dd5ee7dcff20fe058798b60d0210ca80","_npmUser":{"name":"atomisadev","actor":{"name":"atomisadev","type":"user","email":"atomdevelops@protonmail.com"},"email":"atomdevelops@protonmail.com"},"_npmVersion":"11.3.0","description":"A blazingly fast, simple, and quite elegant CLI for turning Markdown notes into a static website.","directories":{},"_nodeVersion":"24.0.1","dependencies":{"chalk":"^5.3.0","marked":"^15.0.12","chokidar":"^4.0.3","commander":"^14.0.0","@types/node":"^22.15.30","gray-matter":"^4.0.3"},"_hasShrinkwrap":false,"devDependencies":{"@types/bun":"latest"},"peerDependencies":{"typescript":"^5"},"_npmOperationalInternal":{"tmp":"tmp/notesmd_1.0.0_1750259764738_0.9963292753923199","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@atomisadev/notesmd","version":"1.0.1","bin":{"notes":"src/index.ts"},"module":"src/index.ts","type":"module","devDependencies":{"@types/bun":"latest"},"peerDependencies":{"typescript":"^5"},"dependencies":{"@types/node":"^22.15.30","chalk":"^5.3.0","chokidar":"^4.0.3","commander":"^14.0.0","gray-matter":"^4.0.3","marked":"^15.0.12"},"_id":"@atomisadev/notesmd@1.0.1","gitHead":"bfc18fb85c234e3fcac3318e51c771e133d30fcb","description":"A blazingly fast, simple, and quite elegant CLI for turning Markdown notes into a static website.","_nodeVersion":"24.0.1","_npmVersion":"11.3.0","dist":{"integrity":"sha512-kdP2B2fX2xpmM5mXEEmaojbcjaK1cohTbLOv2QsF7YeWe8ZPg/S1CdmdDWMjWbC5JJH5aqE5jbr8tLH11QKnrw==","shasum":"06a0aae37d7d939923952e8bf00b6f7ddb61f551","tarball":"https://registry.npmjs.org/@atomisadev/notesmd/-/notesmd-1.0.1.tgz","fileCount":19,"unpackedSize":34507,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAiFs1VBbBo3Ka6NijaTxJzljJO3SIpp37Lb8DRD1PAzAiEAzmC8r/QsxYdjk8kwYT/sxD+ULVVXPl8PLCe6miGEIb8="}]},"_npmUser":{"name":"atomisadev","email":"atomdevelops@protonmail.com","actor":{"name":"atomisadev","email":"atomdevelops@protonmail.com","type":"user"}},"directories":{},"maintainers":[{"name":"atomisadev","email":"atomdevelops@protonmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/notesmd_1.0.1_1750260198832_0.09080455847933289"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-18T15:16:04.645Z","modified":"2025-06-18T15:23:19.263Z","1.0.0":"2025-06-18T15:16:04.935Z","1.0.1":"2025-06-18T15:23:19.087Z"},"description":"A blazingly fast, simple, and quite elegant CLI for turning Markdown notes into a static website.","maintainers":[{"name":"atomisadev","email":"atomdevelops@protonmail.com"}],"readme":"# notesmd\n\nA blazingly fast, simple, and quite elegant CLI for turning Markdown notes into a static website.\n\n## What is `notesmd`?:\n\n`notesmd` is a command line tool that transforms a directory of your markdown notes into a clean, modern, and navigable static HTML site (all custom coded btw). It's built with Bun and TypeScript and prioritizes speed and ease of use above all else.\n\nIt reads your `.md` files, parses metadata like `title`, `author`, and `date` from the front-matter, and then it injects that content into a customizable HTML template. The result is a complete, self-contained website ready to be deployed anywhere.\n\n### Key Features\n\n- **Blazingly fast:** Built on [Bun](https://bun.sh/), it's incredibly fast\n- **Markdown first:** Write your notes in standard Markdown with YAML front-matter\n- **Live-reload server:** Run `notes watch` to start a local dev server that automatically rebuilds and refreshes your browser on any change\n- **Automatic index page:** An `index.html` is automatically generated with a grid of all your posts, linking to each single one\n- **Scaffolding:** You can get started in seconds with the `notes init` command\n- **Zero-config:** Works right out of the box with sensible defaults\n\n## Why I Created It\n\nWhen I was in school, I built a very similar tool myself. It was simple, extremely fast, and let me organize my class notes in a way that just made sense to me. I could write in Markdown, and it would quickly generate a site I could browse through. It wasn't pretty, but it was functional.\n\nI found that existing apps like Obsidian, while they were powerful, were bloated for what I needed. I didn't need complex graphs or like an entire damn mountain of plugins, I just wanted to write decent notes and have them somewhat organized.\n\n`notesmd` is the refined and recoded version of that original tool. It's a modern take on the same core idea: a lightweight, basically no nonsense, note-taking and publishiung workflow that looks great and works better.\n\n## Requirements\n\nThe only requirement is [Bun](https://bun.sh/) (v1.0 or later). You can also run this app very similar through an `npm` package manager. So, `npm`, `pnpm`, `yarn`, etc.\n\n## How to Run It\n\n### Installation\n\nIt is published to the `npm` registry. All you have to do is install it.\n\n```bash\nbun install -g @atomisadev/notesmd\n```\n\n### Usage & Commands\n\nHere is a complete list of available commands.\n\n#### `notes init [directory-name]`\n\nInitializes a new project with a default file structure.\n\n- if `[directory-name]` is provided, then it creates a new folder\n- if you use `.` or `./` as the directory name, it initializes in the current folder.\n- if you provide no name, then it defaults to creating a `notes-project` directory\n\n##### Example\n\n```bash\n# Creates a project in a new folder called \"cs112dsa\"\nnotes init cs112dsa\n\n# Create a project in the current folder\nmkdir my-blog && cd my-blog\nnotes init .\n```\n\n#### `notes build`\n\nPerforms a one-time build, converting your files from the `notes` directory into a static site in the `dist` directory.\n\n##### Example:\n\n```bash\nnotes build\n```\n\n#### `notes watch`\n\nThis is for development. It starts a live-reloading development server. It will:\n\n- Perform an initial build\n- Start a web server (defaults to `http://localhost:3000`)\n- Watch all your source files (`notes/`, `public/`, `template.html`) for changes & will automatically rebuild the site\n\n##### Example\n\n```bash\nnotes watch\n```\n\n#### `notes serve`\n\nStarts a simple static web server for your `dist` directory, which allows you to preview the production build\n\n##### Example\n\n```bash\nnotes serve --port 8080\n```\n\n#### Example Workflow\n\nHere's how you can go from zero to a running site in under a minute:\n\n```bash\n# 1. Create a new project\nnotes init cs112dsa\n\n# 2. Go to the new project\ncd cs112dsa\n\n# 3. Start the dev server\nnotes watch\n\n# 4. Open http://localhost:3000 in your browser and start editing your notes\n```\n","readmeFilename":"README.md"}