{"id":19815595,"url":"https://github.com/ctxz/mkbooks","last_synced_at":"2026-05-11T13:04:45.675Z","repository":{"id":95124901,"uuid":"129141617","full_name":"CTXz/mkbooks","owner":"CTXz","description":"A bash script that turns your Mkdocs project into a PDF or EPUB!","archived":false,"fork":false,"pushed_at":"2019-06-12T13:18:49.000Z","size":6,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-28T19:28:59.510Z","etag":null,"topics":["convert","epub","export","mkdocs","pdf","to"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CTXz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-04-11T19:07:39.000Z","updated_at":"2024-11-04T12:30:40.000Z","dependencies_parsed_at":"2023-05-26T20:45:22.870Z","dependency_job_id":null,"html_url":"https://github.com/CTXz/mkbooks","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CTXz/mkbooks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CTXz%2Fmkbooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CTXz%2Fmkbooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CTXz%2Fmkbooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CTXz%2Fmkbooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CTXz","download_url":"https://codeload.github.com/CTXz/mkbooks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CTXz%2Fmkbooks/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32895978,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-10T13:40:02.631Z","status":"online","status_checked_at":"2026-05-11T02:00:05.975Z","response_time":120,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["convert","epub","export","mkdocs","pdf","to"],"created_at":"2024-11-12T10:06:30.488Z","updated_at":"2026-05-11T13:04:45.670Z","avatar_url":"https://github.com/CTXz.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkbooks\n\nA script that turns your [Mkdocs](http://Mkdocs.org) project into a PDF or EPUB!\n\n## Contents\n\n- [Dependencies](#dependencies)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Troubleshooting](#troubleshooting)\n- [License](#license)\n\n## Dependencies\n\nThe following software dependencies are required for the script to work:\n\n- [mdpdf](https://github.com/BlueHatbRit/mdpdf)\n- [pandoc](https://pandoc.org/)\n\nOn Ubuntu 17.10+ systems, those can be obtained the following way:\n```\n$ sudo apt install npm pandoc\n$ sudo npm install -g mdpdf --unsafe-perm=true\n```\n\n## Installation\n\nClone the repository:\n\n```bash\n$ git clone https://github.com/CTXz/mkbooks.git\n```\n\nFrom here, the script may be executed directly:\n```\n$ cd mkbooks\n$ bash mkbooks.sh -h\n```\n\nAdditionally, you may install the script to `/usr/local/bin`!\n\n```\n# cp mkbooks.sh /usr/local/bin/\n# chmod +x /usr/local/bin/mkbooks.sh\n```\n\n## Usage:\n\nTo run the script:\n\n```\n$ bash mkbooks.sh [-h] \u003ccfg\u003e \u003cout\u003e [extra]\n```\n\n### Options/Arguments\n\n|Argument|Description                                                                                               |\n|--------|----------------------------------------------------------------------------------------------------------|\n|-h      |Display this usage                                                                                        |\n|cfg     |Path to the Mkdocs yml configuration file                                                                 |\n|out     |Name and type of the output file (Example: Docs.pdf or Docs.epub)                                         |\n|extra   |Additional arguments that are passed to mdpdf or pandoc (pdf = mdpdf, pandoc = epub). Use quotation marks!|\n\n### Examples\n\n```\n$ bash mkbooks.sh ./mkdocs.yml docs.pdf\n$ bash mkbooks.sh ./mkdocs.yml docs.epub\n$ bash mkbooks.sh ./mkdocs.yml docs.pdf '--style=styles.css'\n```\n\nIf no error has occurred, a PDF or EPUB will be generated!\n\n## Troubleshooting:\n\nShould mkbooks complain that mdpdf has not been installed:\n\n```\nmkbooks: mdpdf has not been installed!\n```\n\ndespite mdpdf being installed, mdpdf may be improperly executing. Try to run `mdpdf` and see if an error is being thrown.\n\nShould `mdpdf` return the following error:\n\n```\n/usr/bin/env: ‘node\\r’: No such file or directory\n```\n\nThen the newline formatting of the mdpdf script is set to CRLF. To fix this issue, open the mdpdf script in `/usr/local/bin/mdpdf` with a text editor that can convert from CRLF to LF. Alternatively, you can use the [dos2unix](http://manpages.ubuntu.com/manpages/trusty/man1/dos2unix.1.html) tool.\n\n## License\nThis project is licensed under the MIT License\n\n```\nCopyright (c) 2018 Patrick Pedersen \u003cctx.xda@gmail.com\u003e=\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctxz%2Fmkbooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctxz%2Fmkbooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctxz%2Fmkbooks/lists"}