{"id":17116063,"url":"https://github.com/andersevenrud/mdtome","last_synced_at":"2025-04-13T04:14:59.939Z","repository":{"id":57293712,"uuid":"147874814","full_name":"andersevenrud/mdtome","owner":"andersevenrud","description":"Markdown Tome is a Gitbook clone","archived":false,"fork":false,"pushed_at":"2018-11-02T23:49:11.000Z","size":182,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T04:14:49.985Z","etag":null,"topics":["documentation","gitbook","markdown","mdtome"],"latest_commit_sha":null,"homepage":"https://andersevenrud.github.io/mdtome","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/andersevenrud.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}},"created_at":"2018-09-07T21:06:41.000Z","updated_at":"2022-11-27T06:07:38.000Z","dependencies_parsed_at":"2022-09-01T08:40:40.498Z","dependency_job_id":null,"html_url":"https://github.com/andersevenrud/mdtome","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andersevenrud%2Fmdtome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andersevenrud%2Fmdtome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andersevenrud%2Fmdtome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andersevenrud%2Fmdtome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andersevenrud","download_url":"https://codeload.github.com/andersevenrud/mdtome/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248661718,"owners_count":21141451,"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":["documentation","gitbook","markdown","mdtome"],"created_at":"2024-10-14T17:47:44.806Z","updated_at":"2025-04-13T04:14:59.915Z","avatar_url":"https://github.com/andersevenrud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mdtome\n\n**Markdown Tome** - A Gitbook clone.\n\n* Fast\n* Simple\n* Compatible with Gitbook structure(s)\n* Produces optimized builds\n* Creates sitemaps by default\n* Can generate PDFs\n* Google Analytics and Adsense built in by default\n\nExample: https://andersevenrud.github.io/mdtome\n\n## Requirements\n\nNode 8.x or later.\n\n## Installation\n\n```\nnpm install -g mdtome\n```\n\n\u003e You can also install this locally in your projects.\n\n## Configuration\n\nCreate a file named `.mdtome`\n\n```javascript\nmodule.exports = {\n  input: '.',\n  title: 'My Awesome Tome',\n  url: 'http://my-website.com'\n};\n```\n\nSee `src/config.js` for a full list of options. *TODO: Add table here*\n\n*Regular Gitbook `book.json` file is also supported, but will not allow you to make any customization.*\n\n## Usage\n\nThe generated output will be in `_book/` by default.\n\n### CLI\n\nSimply run this command in your project root directory:\n\n```bash\nmdtome [--input=path] [--output=path] [--pdf=path] [--verbose] [--watch]\n```\n\nOr if you have mdtome as a dependency in your project:\n\n```bash\nnpx mdtome [--input=path] [--output=path] [--pdf=path] [--verbose] [--watch]\n```\n\n\u003e Note, use `NODE_ENV=production mdtome ...` to make an optimized build.\n\n### API\n\n```javascript\nconst mdtome = require('mdtome');\n\nmdtome({\n  /* Configuration options here */\n  /* Same as the .mdtome file */\n}) // -\u003e Promise\n```\n\n#### Plugins\n\n```\nmodule.exports = {\n  // Per page render\n  render: html =\u003e Promise.resolve(html)\n\n  // Template loading\n  template =\u003e (html, pdf) =\u003e Promise.resolve(html)\n};\n```\n\n## Benchmarks\n\nUsing https://github.com/bagder/everything-curl\n\n* Gitbook: `23.79s user 0.73s system 108% cpu 22.495 total`\n* mdtome: `4.18s user 0.18s system 110% cpu 3.952 total`\n\nSystem: i5-4670K + SSD\n\n## TODO\n\n* Generation: Glossary\n* Generation: Languages\n* Plugin: Typed quotes\n* Customization: CSS/JS entry points\n* UI: Highlight links based on scroll\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandersevenrud%2Fmdtome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandersevenrud%2Fmdtome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandersevenrud%2Fmdtome/lists"}