{"id":13426211,"url":"https://github.com/Symbitic/markbook","last_synced_at":"2025-03-15T21:30:48.355Z","repository":{"id":38260302,"uuid":"176364215","full_name":"Symbitic/markbook","owner":"Symbitic","description":"Write books in CommonMark.","archived":false,"fork":false,"pushed_at":"2023-01-03T18:04:00.000Z","size":2858,"stargazers_count":32,"open_issues_count":11,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-14T21:07:23.904Z","etag":null,"topics":["commonmark","gitbook","markdown","remark"],"latest_commit_sha":null,"homepage":"https://symbitic.github.io/markbook/","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/Symbitic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-18T20:28:17.000Z","updated_at":"2024-08-22T07:30:36.000Z","dependencies_parsed_at":"2023-02-01T08:31:50.688Z","dependency_job_id":null,"html_url":"https://github.com/Symbitic/markbook","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Symbitic%2Fmarkbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Symbitic%2Fmarkbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Symbitic%2Fmarkbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Symbitic%2Fmarkbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Symbitic","download_url":"https://codeload.github.com/Symbitic/markbook/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243792290,"owners_count":20348610,"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":["commonmark","gitbook","markdown","remark"],"created_at":"2024-07-31T00:01:29.058Z","updated_at":"2025-03-15T21:30:47.852Z","avatar_url":"https://github.com/Symbitic.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# [Markbook](https://symbitic.github.io/markbook/)\n\n[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![Travis](https://img.shields.io/travis/Symbitic/markbook.svg?style=flat-square)](https://travis-ci.org/Symbitic/markbook)\n[![license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://opensource.org/licenses/MIT)\n[![stars](https://img.shields.io/github/stars/symbitic/markbook.svg?style=flat-square)](https://github.com/Symbitic/markbook)\n\u003e Write books in CommonMark.\n\nMarkbook allows full books to be written in CommonMark.\n\nRead the user guide on \u003chttps://symbitic.github.io/markbook/\u003e.\n\nIf you like this project, please consider doing one of the following:\n* Starring me on GitHub\n* [Contributing](#contributing)\n* [Buying me a soda](https://buymeacoff.ee/qh0rXkiCd) (can't have coffee -- my kidney's would explode)\n\n[![BuyMeACoffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoff.ee/qh0rXkiCd)\n\n## Getting Started\n\nMarkbook provides binary files for Windows, macOS, and Linux.\nDownload the latest release at \u003chttps://github.com/Symbitic/markbook/releases/latest\u003e.\n\nAlternately, Markbook can be built manually:\n\n    git clone https://github.com/Symbitic/markbook.git\n    cd markbook\n    npm install\n    npm run build\n    npm run watch\n\n## Features\n\n* Build/Serve/Init/Clean commands.\n* Auto-reload on file changes.\n* Package markbook as a binary file for easier system-wide install.\n* Generate HTML from CommonMark files and a Handlebars theme.\n* Table of Contents.\n* Mobile-friendly interface.\n* Generate PDF (requires Chrome or Chromium installed)\n* Generate EPUB (very basic for the moment).\n\n### Planned\n\n* [ ] User-supplied themes.\n* [ ] Better rendering efficiency.\n* [ ] Consider using TypeScript (@babel/preset-typescript).\n* [ ] Better/More tests.\n* [ ] Release on NPM.\n* [ ] Expose an API for developer use.\n* [ ] Support other templating engines (pug, nunjucks).\n* [ ] Find typeface for ebooks (Amazon Kindle and Google Play Books each has custom typeface specific for reading ebooks).\n* [ ] Mermaid, graphviz, or PlantUML diagrams.\n* [ ] Add Pandoc/rmarkdown extensions.\n* [ ] Add remark-lint command to allow linting/spell-checking.\n* [ ] Support deploying to gh-pages.\n\n## Contributing\n\nPlease see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## License\n\nLicensed under the [MIT](https://spdx.org/licenses/MIT) license. See [LICENSE.md](LICENSE.md) for more details.\n\nCopyright \u0026copy; 2018-2019 [Markbook Contributors](https://github.com/Symbitic/markbook/graphs/contributors)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSymbitic%2Fmarkbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSymbitic%2Fmarkbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSymbitic%2Fmarkbook/lists"}