{"id":19383733,"url":"https://github.com/jill64/exmarkdown-code-utility","last_synced_at":"2025-04-23T21:32:01.072Z","repository":{"id":193855080,"uuid":"689547347","full_name":"jill64/exmarkdown-code-utility","owner":"jill64","description":"❏ Code utility plugin for svelte-exmarkdown","archived":false,"fork":false,"pushed_at":"2025-04-13T21:58:10.000Z","size":2692,"stargazers_count":4,"open_issues_count":10,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T22:37:33.620Z","etag":null,"topics":["code","library","markdown","plugin","svelte"],"latest_commit_sha":null,"homepage":"https://exmarkdown-code-utility.jill64.dev","language":"TypeScript","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/jill64.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2023-09-10T06:42:33.000Z","updated_at":"2025-04-13T21:58:14.000Z","dependencies_parsed_at":"2023-09-10T13:00:55.770Z","dependency_job_id":"e8945449-8c61-46a5-a697-40e0d27ff623","html_url":"https://github.com/jill64/exmarkdown-code-utility","commit_stats":null,"previous_names":["jill64/exmarkdown-code-utility"],"tags_count":138,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jill64%2Fexmarkdown-code-utility","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jill64%2Fexmarkdown-code-utility/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jill64%2Fexmarkdown-code-utility/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jill64%2Fexmarkdown-code-utility/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jill64","download_url":"https://codeload.github.com/jill64/exmarkdown-code-utility/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250517961,"owners_count":21443865,"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":["code","library","markdown","plugin","svelte"],"created_at":"2024-11-10T09:27:33.962Z","updated_at":"2025-04-23T21:32:00.777Z","avatar_url":"https://github.com/jill64.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!----- BEGIN GHOST DOCS HEADER -----\u003e\n\n# exmarkdown-code-utility\n\n\u003c!----- BEGIN GHOST DOCS BADGES -----\u003e\n\n\u003ca href=\"https://npmjs.com/package/exmarkdown-code-utility\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/exmarkdown-code-utility\" alt=\"npm-version\" /\u003e\u003c/a\u003e \u003ca href=\"https://npmjs.com/package/exmarkdown-code-utility\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/exmarkdown-code-utility\" alt=\"npm-license\" /\u003e\u003c/a\u003e \u003ca href=\"https://npmjs.com/package/exmarkdown-code-utility\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/exmarkdown-code-utility\" alt=\"npm-download-month\" /\u003e\u003c/a\u003e \u003ca href=\"https://npmjs.com/package/exmarkdown-code-utility\"\u003e\u003cimg src=\"https://img.shields.io/bundlephobia/min/exmarkdown-code-utility\" alt=\"npm-min-size\" /\u003e\u003c/a\u003e \u003ca href=\"https://github.com/jill64/exmarkdown-code-utility/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://github.com/jill64/exmarkdown-code-utility/actions/workflows/ci.yml/badge.svg\" alt=\"ci.yml\" /\u003e\u003c/a\u003e \u003ca href=\"https://exmarkdown-code-utility.jill64.dev\"\u003e\u003cimg src=\"https://img.shields.io/website?up_message=working\u0026down_message=down\u0026url=https%3A%2F%2Fexmarkdown-code-utility.jill64.dev\" alt=\"website\" /\u003e\u003c/a\u003e\n\n\u003c!----- END GHOST DOCS BADGES -----\u003e\n\n❏ Code utility plugin for svelte-exmarkdown\n\n## [Demo](https://exmarkdown-code-utility.jill64.dev)\n\n\u003c!----- END GHOST DOCS HEADER -----\u003e\n\nThis plugin adds the following utility to code section in [svelte-exmarkdown](https://github.com/ssssota/svelte-exmarkdown)\n\n- Code Copy Button\n- Show Filename\n- Code Highlighting by [svelte-highlight](https://github.com/metonym/svelte-highlight)\n\n## Installation\n\n```bash\nnpm i exmarkdown-code-utility\n```\n\n## Example\n\n```svelte\n\u003cscript\u003e\n  import { codeUtility } from 'exmarkdown-code-utility'\n  import { Markdown } from 'svelte-exmarkdown'\n\u003c/script\u003e\n\n\u003cMarkdown\n  plugins={[\n    // ...\n    codeUtility({\n      // Plugin Options\n    })\n  ]}\n/\u003e\n\n\u003cstyle\u003e\n  .exmarkdown-code-filename {\n    /* Style of Filename section (\u003cdiv/\u003e) */\n  }\n\u003c/style\u003e\n```\n\n[Full Plugin Options](./src/lib/types/Options.ts)\n\nThis will result in the following conversions\n\nMarkdown\n\n````md\n```html:filename\n\u003c!-- ... --\u003e\n```\n````\n\n↓\n\nHTML\n\n```html\n\u003cdiv class=\"exmarkdown-code-filename\"\u003efilename\u003c/div\u003e\n\u003cdiv\u003e\n  \u003cbutton class=\"exmarkdown-code-copy\"\u003e❏\u003c/button\u003e\n  \u003cpre\u003e\n    \u003ccode\u003e\n      \u003c!-- ... --\u003e\n    \u003c/code\u003e\n  \u003c/pre\u003e\n\u003c/div\u003e\n```\n\n## Code Highlighting\n\nThis plugin uses [svelte-highlight](https://github.com/metonym/svelte-highlight) for code highlighting.\n\n### Usage\n\n1. Enable the `highlight` option\n\n```svelte\n\u003cscript\u003e\n  import { Markdown } from 'svelte-exmarkdown'\n  import { codeUtility } from 'exmarkdown-code-utility'\n\u003c/script\u003e\n\n\u003cMarkdown\n  plugins={[\n    codeUtility({\n      highlight: true\n    })\n  ]}\n/\u003e\n```\n\n2. Import the stylesheet\n\n\u003e [!TIP]\n\u003e See [svelte-highlight/styling](https://github.com/metonym/svelte-highlight?tab=readme-ov-file#styling) for details.\n\n```svelte\n\u003cscript\u003e\n  import 'exmarkdown-code-utility/styles/github.css'\n\u003c/script\u003e\n```\n\nor\n\n```svelte\n\u003cscript lang=\"ts\"\u003e\n  import github from 'exmarkdown-code-utility/styles/github'\n\u003c/script\u003e\n\n\u003csvelte:head\u003e\n  {@html github}\n\u003c/svelte:head\u003e\n```\n\n\u003e [!CAUTION] \u003e [`@html` is dangerous](https://svelte.dev/docs/special-tags#html).  \n\u003e If you need to switch dynamic styles, use of [svelte-highlight-switcher](https://github.com/jill64/svelte-highlight-switcher#readme) is recommended to prevent unexpected accidents.\n\n## Migration from v2\n\nNow internal using to [svelte-code-copy](https://github.com/jill64/svelte-code-copy#readme) for code copy button.\n\n- `onCopy` option has been merged into `codeCopy`.\n- `codeButton` option has been merged into `copy`.\n- Omit styling by `exmarkdown-code-copy`. Use instead `codeCopy` option.\n\n\u003c!----- BEGIN GHOST DOCS FOOTER -----\u003e\n\n## License\n\n[MIT](LICENSE)\n\n\u003c!----- END GHOST DOCS FOOTER -----\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjill64%2Fexmarkdown-code-utility","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjill64%2Fexmarkdown-code-utility","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjill64%2Fexmarkdown-code-utility/lists"}