{"_id":"@codemeall/create-markdown-pages","_rev":"5-0caee690d026e9c541e7e8bb51896367","name":"@codemeall/create-markdown-pages","dist-tags":{"latest":"0.1.12"},"versions":{"0.1.8":{"name":"@codemeall/create-markdown-pages","version":"0.1.8","license":"MIT","_id":"@codemeall/create-markdown-pages@0.1.8","maintainers":[{"name":"codemeall","email":"mdab.aziz01@gmail.com"}],"bin":{"create-markdown-pages":"bin/create-markdown-pages.js"},"dist":{"shasum":"73f64f4ef3fc260127f6772292c9edfd07950d01","tarball":"https://registry.npmjs.org/@codemeall/create-markdown-pages/-/create-markdown-pages-0.1.8.tgz","fileCount":28,"integrity":"sha512-FCvLC48AcU/wiGq+GUf4zHhku8rWNld2yxC8UaKoR9PZhabZ+o/pBppTOgA2kQ9QGivKgqArWwr8LpKjHm02vg==","signatures":[{"sig":"MEQCIBQ6SoLtzbHg4pltfsRtLTeqMF4hNwSg8l2MCBVIbXMIAiA7htDLBxm8TJMI45pWazybYlQQx/le2HUiQpZIPn88yQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":55242},"type":"module","engines":{"npm":">=10.9","node":">=22"},"gitHead":"941fc37e37fcf206725073043119d96af2bc9975","scripts":{"test":"node --test"},"_npmUser":{"name":"codemeall","email":"mdab.aziz01@gmail.com"},"_npmVersion":"10.9.8","description":"Scaffold a Markdown Pages Obsidian-to-GitHub-Pages starter.","directories":{},"_nodeVersion":"22.22.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-markdown-pages_0.1.8_1780830636460_0.04692711728741461","host":"s3://npm-registry-packages-npm-production"}},"0.1.9":{"name":"@codemeall/create-markdown-pages","version":"0.1.9","license":"MIT","_id":"@codemeall/create-markdown-pages@0.1.9","maintainers":[{"name":"codemeall","email":"mdab.aziz01@gmail.com"}],"bin":{"create-markdown-pages":"bin/create-markdown-pages.js"},"dist":{"shasum":"2367db3d0f9694974d3658b772316ee8ea403e9a","tarball":"https://registry.npmjs.org/@codemeall/create-markdown-pages/-/create-markdown-pages-0.1.9.tgz","fileCount":33,"integrity":"sha512-XBr9Zg/MVRLmQiRawC7BUDee68MmHodZn3YJviHuxFuVmbIh4epJqkCAGFnUpiXXdZg9OInrQDTBRgvw1wNIRw==","signatures":[{"sig":"MEUCIQDwFCrbz3P6JiDq5RT6PFbSUjtjJUCwQROkOz/pC3aikAIgdCO7NbefutAPww7OrcldxHIKuEeXzJVLzAImhnHjYrM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":62879},"type":"module","engines":{"npm":">=10.9","node":">=22"},"gitHead":"9b21129ca792149458fe5be1f5574b82553ad5ee","scripts":{"test":"node --test"},"_npmUser":{"name":"codemeall","email":"mdab.aziz01@gmail.com"},"_npmVersion":"10.9.8","description":"Scaffold a Markdown Pages Obsidian-to-GitHub-Pages starter.","directories":{},"_nodeVersion":"22.22.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-markdown-pages_0.1.9_1780848094098_0.6793896811941957","host":"s3://npm-registry-packages-npm-production"}},"0.1.10":{"name":"@codemeall/create-markdown-pages","version":"0.1.10","license":"MIT","_id":"@codemeall/create-markdown-pages@0.1.10","maintainers":[{"name":"codemeall","email":"mdab.aziz01@gmail.com"}],"bin":{"create-markdown-pages":"bin/create-markdown-pages.js"},"dist":{"shasum":"fd8053bbfe593e6a9e3cfbb4047226f9fc7dfe46","tarball":"https://registry.npmjs.org/@codemeall/create-markdown-pages/-/create-markdown-pages-0.1.10.tgz","fileCount":36,"integrity":"sha512-VZqE3IhiKNkDiKSEV0Jir/v/MNqcbZSjasu/dxrCplAC97lIn/bq1TdepLS8MRAupomkKsde+VsDi1KwAQua4Q==","signatures":[{"sig":"MEYCIQDeP9HlNChcbef3o8wKf0XdmT1mgd1DFRFYuiuoJn9ThAIhAMMkza4qk5EKu+j6txcRjTPVKCvK1qp6AY98Y7EtVKrh","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":66656},"type":"module","engines":{"npm":">=10.9","node":">=22"},"gitHead":"dde4b224d056fdb7b2873fca994c521865862747","scripts":{"test":"node --test"},"_npmUser":{"name":"codemeall","email":"mdab.aziz01@gmail.com"},"_npmVersion":"10.9.8","description":"Scaffold a Markdown Pages Obsidian-to-GitHub-Pages starter.","directories":{},"_nodeVersion":"22.22.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-markdown-pages_0.1.10_1780849174148_0.2724139994917121","host":"s3://npm-registry-packages-npm-production"}},"0.1.11":{"name":"@codemeall/create-markdown-pages","version":"0.1.11","license":"MIT","_id":"@codemeall/create-markdown-pages@0.1.11","maintainers":[{"name":"codemeall","email":"mdab.aziz01@gmail.com"}],"bin":{"create-markdown-pages":"bin/create-markdown-pages.js"},"dist":{"shasum":"a64466344ad972ac6ff9f1a60ab316fa4fb3b981","tarball":"https://registry.npmjs.org/@codemeall/create-markdown-pages/-/create-markdown-pages-0.1.11.tgz","fileCount":36,"integrity":"sha512-0E1asxP9GuOB3JZ0z9EPaBclqQoFrusLk5eAVtu9Cdg5xiY90NRdPreU2zk9ov8OoV+fw8kccz4DKwzPdlLgNw==","signatures":[{"sig":"MEYCIQCQv+PtwkC0pxpyC+gwb5hm/s8PxV4KmBTArHxDs8qyJQIhAJ+78VS1RJ9Xn6IaXjeVTYxPoKJVzlxehD0Bky82C/HM","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":67166},"type":"module","engines":{"npm":">=10.9","node":">=22"},"gitHead":"f5ef7d627eff3d20cf55a5d211d4f55169313a3d","scripts":{"test":"node --test"},"_npmUser":{"name":"codemeall","email":"mdab.aziz01@gmail.com"},"_npmVersion":"10.9.8","description":"Scaffold a Markdown Pages Obsidian-to-GitHub-Pages starter.","directories":{},"_nodeVersion":"22.22.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/create-markdown-pages_0.1.11_1780851122888_0.6097004019718912","host":"s3://npm-registry-packages-npm-production"}},"0.1.12":{"name":"@codemeall/create-markdown-pages","version":"0.1.12","description":"Scaffold a Markdown Pages Obsidian-to-GitHub-Pages starter.","type":"module","bin":{"create-markdown-pages":"bin/create-markdown-pages.js"},"scripts":{"test":"node --test"},"engines":{"node":">=22","npm":">=10.9"},"license":"MIT","_id":"@codemeall/create-markdown-pages@0.1.12","gitHead":"60968dc0b8a9924bcdd09463a2c91fa051cdae7e","_nodeVersion":"22.22.3","_npmVersion":"10.9.8","dist":{"integrity":"sha512-eYFgJPdJ8IzcnaY9WFbOiletqTUSRKDv3Pwm6QrnCJ1OX0cZYn93cAlVtY5iMl/dCGkiBvYD0KsdkvgZbC9O2g==","shasum":"f67ae8752aae5aeb2265f270a058f9a3effa5f0e","tarball":"https://registry.npmjs.org/@codemeall/create-markdown-pages/-/create-markdown-pages-0.1.12.tgz","fileCount":37,"unpackedSize":76794,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIF5zl3mrk8sDm1OBfkjJ4iZaEGp+pQKYuVgmCdfPniV+AiEA7ZYntdtCI1rYPpowuIpJ8znF+qgBlXIVTZI0jUV9S18="}]},"_npmUser":{"name":"codemeall","email":"mdab.aziz01@gmail.com"},"directories":{},"maintainers":[{"name":"codemeall","email":"mdab.aziz01@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/create-markdown-pages_0.1.12_1780851500566_0.6613914606506126"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-07T11:10:36.301Z","modified":"2026-06-07T16:58:20.832Z","0.1.8":"2026-06-07T11:10:36.599Z","0.1.9":"2026-06-07T16:01:34.270Z","0.1.10":"2026-06-07T16:19:34.303Z","0.1.11":"2026-06-07T16:52:03.029Z","0.1.12":"2026-06-07T16:58:20.705Z"},"license":"MIT","description":"Scaffold a Markdown Pages Obsidian-to-GitHub-Pages starter.","maintainers":[{"name":"codemeall","email":"mdab.aziz01@gmail.com"}],"readme":"# Markdown Pages\n\nMarkdown Pages turns an Obsidian-authored Markdown vault into a Quartz-powered portfolio, blog, and knowledge-base site that can be deployed to GitHub Pages.\n\nIt is designed for people who want to manage content locally in Obsidian, keep source files in GitHub, and publish a static public site without paid sync or hosted storage.\n\n## Quick Start\n\nRequirements:\n\n- Node.js 22 or newer\n- npm 10.9 or newer\n- A GitHub account\n- Obsidian, optional but recommended\n\nCreate a new site:\n\n```bash\nnpx @codemeall/create-markdown-pages my-site\ncd my-site\nnpm install\nnpm run wizard\nnpm run preview\n```\n\nThe wizard opens in your default browser. After saving, return to the terminal, press `Ctrl+C` to stop the wizard, then run `npm run preview`. Open the `content/` folder in Obsidian and start editing.\n\nThe wizard can also set the generated site's page theme. Choose from four starter themes: Paper, Minimal, Editorial, and Notebook. Save the selected theme, then run `npm run preview` or `npm run build` so Markdown Pages writes the matching Quartz colors.\n\n## How Publishing Works\n\nMarkdown Pages uses `content/` as the Obsidian vault. Markdown files render only when they include:\n\n```yaml\n---\ntitle: \"My page\"\ntype: note\npublish: true\ngraph: true\n---\n```\n\nSupported content types:\n\n- `page`: portfolio/home/about pages\n- `post`: blog posts under `/posts/`\n- `note`: knowledge-base notes under `/notes/`\n\nThe generated site is built by Quartz and can be deployed by the included GitHub Actions workflow.\n\nSet `graph: false` in a Markdown file to hide the graph panel for that generated page. Omit it, or set `graph: true`, to keep the graph visible.\n\nImages can live under `content/assets/images/` or root-level `assets/images/` and be embedded from Obsidian with syntax like:\n\n```markdown\n![[hero.png]]\n```\n\nDuring `npm run preview` or `npm run build`, Markdown Pages copies only image assets referenced by published Markdown into the Quartz build input and rewrites those embeds to public site paths.\n\nLocal preview stays live while it runs. When you save published Markdown, referenced assets, or site config locally, Markdown Pages restages the Quartz input so you can verify the site before pushing to GitHub Pages.\n\n## GitHub Pages Setup\n\n1. Create a new GitHub repository.\n2. Push the generated site folder to that repository.\n3. In GitHub, open `Settings -> Pages`.\n4. Under `Build and deployment`, set `Source` to `GitHub Actions`.\n5. Push to `main`.\n\nThe included workflow builds and deploys the site automatically.\n\nIf the deploy job fails with `Failed to create deployment (status: 404)`, GitHub Pages has not been enabled for that repository yet, or the Pages source is not set to GitHub Actions. Open the URL shown in the workflow error, update `Settings -> Pages`, then rerun the workflow.\n\nFor project pages, run the wizard and set your GitHub username and repository name so the site URL is configured correctly.\n\n## Privacy Rule\n\n`publish: true` means “render this file into the public website.”\n\nIt does not make the Markdown source private. If the GitHub repository is public, committed Markdown files may be visible on GitHub even when they are not rendered.\n\nFor private drafts, use a private repository or keep drafts outside the published repo.\n\n## Import Existing Jekyll Posts\n\nIf you have a Jekyll blog with `_posts`, import it like this:\n\n```bash\nnpm run import:jekyll -- /path/to/site/_posts\n```\n\nThe importer copies posts into `content/posts`, adds `type: post`, adds `publish: true`, and preserves common frontmatter such as title, date, tags, category, and description.\n\n## Common Commands\n\n```bash\nnpm run wizard\n```\n\nConfigure site identity, site and page theme, GitHub Pages URL details, and visibility guidance. This opens the local wizard in your default browser.\n\n```bash\nnpm run preview\n```\n\nBuild, serve, and watch the site locally. Leave this command running while you edit `content/` in Obsidian.\n\n```bash\nnpm run build\n```\n\nBuild the static site for production.\n\n```bash\nnpm run prepare:content\n```\n\nStage only publishable Markdown into the Quartz build input.\n\n## Client Handoff Checklist\n\n- Create the site with `npx @codemeall/create-markdown-pages client-site`.\n- Run the wizard and set the correct GitHub username and repository name.\n- Open `content/` in Obsidian.\n- Replace the sample home, about, post, and note files.\n- Commit and push to GitHub.\n- Enable GitHub Pages with GitHub Actions.\n- Confirm the first deployment succeeds.\n\n## License\n\nMIT\n","readmeFilename":"README.md"}