{"id":13623241,"url":"https://github.com/mborne/markdown-to-html","last_synced_at":"2025-04-22T12:12:19.161Z","repository":{"id":33616693,"uuid":"146856066","full_name":"mborne/markdown-to-html","owner":"mborne","description":"An experimental markdown renderer based on marked aiming at providing both a static site generator and a live server","archived":false,"fork":false,"pushed_at":"2024-12-25T21:35:17.000Z","size":2552,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-14T23:02:15.686Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://mborne.github.io/markdown-to-html/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mborne.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-08-31T07:14:43.000Z","updated_at":"2024-09-10T10:03:46.000Z","dependencies_parsed_at":"2023-11-22T07:27:59.661Z","dependency_job_id":"ef1e3e6d-6480-4912-9d6a-95e6f0bed983","html_url":"https://github.com/mborne/markdown-to-html","commit_stats":{"total_commits":138,"total_committers":4,"mean_commits":34.5,"dds":"0.050724637681159424","last_synced_commit":"1c512c39edbcf03d8025ea801d012bc159c49300"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mborne%2Fmarkdown-to-html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mborne%2Fmarkdown-to-html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mborne%2Fmarkdown-to-html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mborne%2Fmarkdown-to-html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mborne","download_url":"https://codeload.github.com/mborne/markdown-to-html/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250153124,"owners_count":21383541,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T21:01:29.470Z","updated_at":"2025-04-22T12:12:19.143Z","avatar_url":"https://github.com/mborne.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# markdown-to-html\n\n[![Node.js CI](https://github.com/mborne/markdown-to-html/actions/workflows/nodejs.yml/badge.svg)](https://github.com/mborne/markdown-to-html/actions/workflows/nodejs.yml) [![Coverage Status](https://coveralls.io/repos/github/mborne/markdown-to-html/badge.svg?branch=master)](https://coveralls.io/github/mborne/markdown-to-html?branch=master)\n\nMarkdown renderer aiming at providing :\n\n* A static site generator (converting .md to .html)\n* A live server (serving rendered .md files)\n\n## Features\n\n* Markdown files are rendered using the powerfull **[Marked](https://github.com/markedjs/marked#marked)** library.\n* [Marked](https://github.com/markedjs/marked#marked) is extended with :\n  * **Table of content generation** in markdown files (`[[toc]]` from [pandoc](https://pandoc.org/))\n  * The support of custom heading links (`# This is the title {#custom-id}`)\n  * The hability to rename `.md` to `.html` for relative links for static site generation.\n* A **basic layout system** based on [handlebars](https://www.npmjs.com/package/handlebars) with some built-in layouts :\n  * **default** to generate classic pages.\n  * **remarkjs** to generate slideshows.\n* [front-matter](https://www.npmjs.com/package/front-matter#front-matter) allows to **use YAML metadata** to :\n  * Overwrite page title (default is file path)\n  * Overwrite page lang (default is `\"en\"`)\n* Partial HTML/JS views can be injected in the **layout** to bypass markdown limitation for some pages.\n\n\n## Usage\n\n### Install\n\n```bash\nnpm install -g @mborne/markdown-to-html\n# check version\nmarkdown-to-html --version\n# show help\nmarkdown-to-html --help\n# markdown-to-html [serve|convert|check] --help\n```\n\n### Generate static website\n\n```bash\nmarkdown-to-html convert samples/01-default-layout /tmp/output\n```\n\n### Serve markdown file\n\n```bash\n# with the default layout\nmarkdown-to-html serve samples/01-default-layout\n# with a custom layout\nmarkdown-to-html serve samples/02-remarkjs --layout remarkjs\n```\n\n### Check markdown files\n\nTo check links between markdown files :\n\n```bash\nmarkdown-to-html check samples/01-default-layout\n# to include HTTP test for remote URLs\nmarkdown-to-html check samples/01-default-layout --check-external-links\n```\n\n## Credits\n\n* [marked](https://www.npmjs.com/package/marked) provides the markdown parser.\n* [handlebars](https://www.npmjs.com/package/handlebars) provides the template engine.\n* [commander](https://www.npmjs.com/package/commander) allows CLI options handling.\n* [shelljs](https://www.npmjs.com/package/shelljs) allows to list files, copy directory, etc.\n* [front-matter](https://www.npmjs.com/package/front-matter#front-matter) allows YAML metadata parsing\n* [marked-custom-heading-id](https://github.com/markedjs/marked-custom-heading-id) provided the solution to support custom heading id.\n* [express](https://www.npmjs.com/package/express) provides the server mode.\n\nIt is inspired from :\n\n* [mixu/markdown-styles](https://github.com/mixu/markdown-styles)\n* [hads](https://github.com/sinedied/hads)\n\n\n## Samples\n\n| Example                                                                                   | Source                                                                              | Layout                                                                                 |\n| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [Classic example](https://mborne.github.io/markdown-to-html/demo/01-default-layout)       | [samples/01-default-layout/index.md](samples/01-default-layout/index.md)            | [layout/default/page.html](layout/default/page.html)                                   |\n| [RemarkJS slideshow](https://mborne.github.io/markdown-to-html/demo/02-remarkjs)          | [samples/02-remarkjs/index.md](samples/01-default-layout/index.md)                  | [layout/remarkjs/page.html](layout/default/page.html)                                  |\n| [GitHub pages generated mixing both](https://mborne.github.io/cours-patron-conception/#1) | [mborne/cours-patron-conception](https://github.com/mborne/cours-patron-conception) | see [build.js](https://github.com/mborne/cours-patron-conception/blob/master/build.js) |\n\n\n## License\n\n[MIT](LICENSE)\n\n## Alternatives\n\nSee [jamstack.org - Site Generators](https://jamstack.org/generators/) :\n\n* [Jellyll](https://jekyllrb.com/)\n* [MkDocs](https://www.mkdocs.org/), [Material for MkDocs](https://github.com/squidfunk/mkdocs-material#readme),...\n* [Docsify](https://docsify.js.org/#/)\n* [Docusaurus](https://docusaurus.io/)\n* [HADS - Hey it's Another Documentation Server!](https://github.com/sinedied/hads)\n* ...\n\n## Docs\n\n* [DEV - Debug with Visual Studio Code](docs/vscode.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmborne%2Fmarkdown-to-html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmborne%2Fmarkdown-to-html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmborne%2Fmarkdown-to-html/lists"}