{"id":15513228,"url":"https://github.com/mProjectsCode/obsidian-shiki-plugin","last_synced_at":"2025-10-12T09:32:22.279Z","repository":{"id":229703146,"uuid":"777333461","full_name":"mProjectsCode/obsidian-shiki-plugin","owner":"mProjectsCode","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-11T15:16:27.000Z","size":507,"stargazers_count":72,"open_issues_count":14,"forks_count":9,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T11:59:57.967Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/mProjectsCode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["mProjectsCode"]}},"created_at":"2024-03-25T16:49:14.000Z","updated_at":"2025-01-23T04:09:21.000Z","dependencies_parsed_at":"2024-06-02T19:14:24.648Z","dependency_job_id":"f75804d4-1fa3-4fd7-ae17-27f41b2a1742","html_url":"https://github.com/mProjectsCode/obsidian-shiki-plugin","commit_stats":null,"previous_names":["mprojectscode/obsidian-shiki-plugin"],"tags_count":18,"template":false,"template_full_name":"mProjectsCode/lemons-plugin-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-shiki-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-shiki-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-shiki-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mProjectsCode%2Fobsidian-shiki-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mProjectsCode","download_url":"https://codeload.github.com/mProjectsCode/obsidian-shiki-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236196809,"owners_count":19110786,"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-10-02T09:54:10.476Z","updated_at":"2025-10-12T09:32:16.993Z","avatar_url":"https://github.com/mProjectsCode.png","language":"TypeScript","funding_links":["https://github.com/sponsors/mProjectsCode"],"categories":["TypeScript"],"sub_categories":[],"readme":"# Obsidian Shiki Plugin\n\nThis plugin integrates [shiki](https://shiki.style/) via [Expressive Code](https://expressive-code.com/) into Obsidian, providing better syntax highlighting for over 100 languages.\n\nThis plugin works in reading, live preview and edit mode, providing a consistent experience across the app.\n\nBelow is an example with line numbers, a custom header, and line highlighting.\n\n![exampleImage](https://raw.githubusercontent.com/mProjectsCode/obsidian-shiki-plugin/master/exampleImage.png)\n\n## Comparison\n\nDefault Obsidian syntax highlighting:\n\n![exampleImageObsidian](https://raw.githubusercontent.com/mProjectsCode/obsidian-shiki-plugin/master/exampleImageObsidian.png)\n\nShiki Plugin syntax highlighting:\n\n![exampleImagePlain](https://raw.githubusercontent.com/mProjectsCode/obsidian-shiki-plugin/master/exampleImagePlain.png)\n\n## Usage\n\nThe plugin will automatically highlight code blocks in your notes.\n\n### Inline Highlighting\n\nThis plugin offers inline code block highlighting. The language for inline code blocks is specified via `{lang} code`.\n\n```md\nSome inline code `{jsx} \u003cbutton role=\"button\" /\u003e`.\n```\n\nThis feature can be turned off in the settings.\n\n### Custom Themes\n\nThis plugin comes bundled with a [wide variety of themes](https://expressive-code.com/guides/themes/#using-bundled-themes). In addition, it supports custom JSON theme files compatible with VS Code. To enable custom themes, create a folder containing your theme files, and specify the folder's path relative to your Vault in the plugin settings. After restarting Obsidian, your custom themes will be available in the Theme dropdown.\n\n## Code Block Configuration\n\nTo configure the code block you add the configuration options on the same line as the opening triple backticks.\n\n````md\n```language configurationHere\nsome code ...\n```\n````\n\nMore info on the configuration options can be found on the [Expressive Code homepage](https://expressive-code.com/).\n\n### Line Numbers\n\nLine numbers can be enabled with `showLineNumbers`.\n\n````md\n```language showLineNumbers\nsome code ...\n```\n````\n\n### Title\n\nA title can be added with `title=\"Title Here\"`.\n\n````md\n```language title=\"Title Here\"\nsome code ...\n```\n````\n\n### Line Highlighting\n\nLine highlighting can be enabled with `{1, 5-10}`.\nLines can either be single lines or ranges.\n\n````md\n```language {1, 5-10}\nsome code ...\n```\n````\n\n### Diff Highlighting\n\nDiff highlighting can be enabled with `ins={1}` and `del={5-10}`.\nLines specified in `ins` will be highlighted green, and lines specified in `del` will be highlighted red.\nLines can once again either be single lines or ranges.\n\n````md\n```language ins={1} del={5-10}\nsome code ...\n```\n````\n\nWhen the language is set to `diff`, the plugin will automatically enable diff highlighting for lines either prefixed by `+` or `-`.\n\n## License\n\n[MIT](https://github.com/mProjectsCode/obsidian-shiki-plugin/blob/master/LICENSE)\n\n## Installation\n\n### Obsidian Marketplace (Recommended)\n\n1. Open `Settings -\u003e Community Plugins` in your vault\n2. Click on the `Browse` button in the `Community plugins` section\n3. Search for `Shiki Highlighter`\n4. Select `Shiki Highlighter` and click first `Install`, then `Enable`\n\n### BRAT\n\n1. Install and enable the `BRAT` plugin\n2. Run the `BRAT: Plugins: Add a beta plugin for testing` command\n3. Enter `https://github.com/mProjectsCode/obsidian-shiki-plugin` into the text field\n4. Click on `Add Pluign`\n\n## Credits\n\nThis plugin uses [shiki](https://shiki.style/), [Expressive Code](https://expressive-code.com/), and parts of the Dracula VSCode theme for syntax highlighting.\n\nSpecial thanks to:\n\n- Hippo (hippotastic) for their work and support with Expressive Code\n- sailKite for CSS help and testing the plugin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FmProjectsCode%2Fobsidian-shiki-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FmProjectsCode%2Fobsidian-shiki-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FmProjectsCode%2Fobsidian-shiki-plugin/lists"}