{"id":22555875,"url":"https://github.com/inkdropapp/inkdrop-export-utils","last_synced_at":"2025-03-28T11:13:19.125Z","repository":{"id":26310775,"uuid":"106520285","full_name":"inkdropapp/inkdrop-export-utils","owner":"inkdropapp","description":"Helper functions for exporting Markdown notes from Inkdrop. Works great with plugins.","archived":false,"fork":false,"pushed_at":"2023-01-08T16:10:59.000Z","size":2132,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-02T11:29:23.892Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.inkdrop.app/","language":"TypeScript","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/inkdropapp.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":"2017-10-11T07:28:11.000Z","updated_at":"2022-04-24T06:53:41.000Z","dependencies_parsed_at":"2023-01-14T04:23:11.673Z","dependency_job_id":null,"html_url":"https://github.com/inkdropapp/inkdrop-export-utils","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-export-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-export-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-export-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inkdropapp%2Finkdrop-export-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inkdropapp","download_url":"https://codeload.github.com/inkdropapp/inkdrop-export-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246017731,"owners_count":20710240,"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-12-07T19:09:14.237Z","updated_at":"2025-03-28T11:13:19.105Z","avatar_url":"https://github.com/inkdropapp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Inkdrop Export Utils\n\nHelper functions for exporting Markdown notes from Inkdrop. Works great with plugins.\n\n## Installation\n\n```\nnpm install inkdrop-export-utils --save\n```\n\n## Usage\n\nImport functions and call them.\n\n```javascript\nimport { renderHTML } from \"inkdrop-export-utils\";\n```\n\n### `async renderHTML (markdown: string): string`\n\nConvert given Markdown to HTML.\nIt utilizes Inkdrop's rendering module to render it, so the output will be same as on the preview pane.\nExtended Markdown syntaxes are also processed such as **math** and **sequence-diagrams**.\n\n### `async createHTML(note: Note, options: { addTitle?: boolean, templateHtml?: string })`\n\nCreates HTML from a given note.\n\n- `options.addTitle`: `true` to add the note title to the top of the note (`# \u003ctitle\u003e`)\n- `options.templateHtml`: A template HTML. (Default: A template loaded from `assets/template.html`)\n\n### `getStylesheets (): string`\n\nIt returns stylesheets provided by plugins that would be necessary for exported HTMLs.\n\n### `async replaceImages (markdown: string, dirToSave: string, basePath?: string): string`\n\nIt exports attached images to specified local directory and replaces URIs in Markdown with their paths.\n\n### `async exportImage (uri: string, dirToSave: string): void`\n\nExport an image with specified URI to the local directory (e.g., `inkdrop://file:H1unDnJFW`)\n\n### `async replaceHTMLImagesWithDataURI (html: string): string`\n\nIt replaces image attachments represented with `inkdrop-file://` in HTML with data URIs (`data:\u003cMIME-TYPE\u003e;base64,\u003cDATA\u003e`).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkdropapp%2Finkdrop-export-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finkdropapp%2Finkdrop-export-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finkdropapp%2Finkdrop-export-utils/lists"}