{"id":13553811,"url":"https://github.com/meff34/docsify-to-pdf-converter","last_synced_at":"2025-04-03T05:31:37.122Z","repository":{"id":34643574,"uuid":"165640167","full_name":"meff34/docsify-to-pdf-converter","owner":"meff34","description":"A tool for building pdf based on your docsify project","archived":false,"fork":false,"pushed_at":"2024-07-16T21:14:00.000Z","size":453,"stargazers_count":90,"open_issues_count":27,"forks_count":29,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-03-03T20:41:21.424Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/meff34.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":"2019-01-14T10:15:22.000Z","updated_at":"2025-01-10T17:45:32.000Z","dependencies_parsed_at":"2024-01-06T21:08:56.630Z","dependency_job_id":"6d91fbe0-74ff-40a7-80ff-7837370b2d48","html_url":"https://github.com/meff34/docsify-to-pdf-converter","commit_stats":{"total_commits":45,"total_committers":2,"mean_commits":22.5,"dds":"0.022222222222222254","last_synced_commit":"aae1db48cce15ebfae744bb0a046cf5c68f56f1e"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meff34%2Fdocsify-to-pdf-converter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meff34%2Fdocsify-to-pdf-converter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meff34%2Fdocsify-to-pdf-converter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meff34%2Fdocsify-to-pdf-converter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meff34","download_url":"https://codeload.github.com/meff34/docsify-to-pdf-converter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246944377,"owners_count":20858773,"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-01T12:02:33.764Z","updated_at":"2025-04-03T05:31:34.933Z","avatar_url":"https://github.com/meff34.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others","Plugins"],"sub_categories":[],"readme":"# docsify-pdf-converter\n\n## Install\n\n```sh\nnpm install --save-dev docsify-pdf-converter\n```\n\n## Usage as CLI:\n\nCreate:\n\n* config file `.docsifytopdfrc.\u003cjs|json|yaml\u003e`\n* or `\"docsifytopdf\"` field in `package.json` (like [rcfile][rcfile] can receive) with this setup object:\n\nExample `.docsifytopdfrc.js` content:\n\n```js\nmodule.exports = {\n  contents: [ \"docs/_sidebar.md\" ], // array of \"table of contents\" files path\n  pathToPublic: \"pdf/readme.pdf\", // path where pdf will stored\n  pdfOptions: \"\u003coptions for puppeteer.pdf()\u003e\", // reference: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pagepdfoptions\n  removeTemp: true, // remove generated .md and .html or not\n  emulateMedia: \"screen\", // mediaType, emulating by puppeteer for rendering pdf, 'print' by default (reference: https://github.com/GoogleChrome/puppeteer/blob/master/docs/api.md#pageemulatemediamediatype)\n}\n```\n\nAdd script into `package.json`:\n\n```json\n{\n  \"scripts\": {\n    \"convert\": \"node_modules/.bin/docsify-pdf-converter\"\n  }\n}\n```\n\nRun converter:\n\n```sh\nnpm run convert\n```\n\n## Usage as npm-package:\n🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧\nThis part of module is not safe for work - it will stop process after generation pdf. Use it for your own risk.\nYou can just import and use main function like this:\n\n```js\nconst converter = require('docsify-pdf-converter');\nconst config = require('./.docsifytopdfrc.js');\n\nconverter(config) // right after resolve or reject inner promise your process will be terminated :C\n```\n🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧\n\n## Contributing\n\n- Fork it!\n- Create your feature branch: `git checkout -b my-new-feature`\n- Commit your changes: `git commit -am 'Add some feature'`\n- Push to the branch: `git push origin my-new-feature`\n- Submit a pull request\n\nYour pull requests and issues are welcome!\n\n[rcfile]: https://www.npmjs.com/package/rcfile\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeff34%2Fdocsify-to-pdf-converter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeff34%2Fdocsify-to-pdf-converter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeff34%2Fdocsify-to-pdf-converter/lists"}