{"id":17597767,"url":"https://github.com/keshann93/markdown-live","last_synced_at":"2025-04-30T05:47:06.104Z","repository":{"id":189193475,"uuid":"195384735","full_name":"keshann93/markdown-live","owner":"keshann93","description":"📝 Real-time Markdown Editor \u0026 Previewer for VS Code","archived":false,"fork":false,"pushed_at":"2020-08-10T08:06:36.000Z","size":62615,"stargazers_count":19,"open_issues_count":4,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-30T05:46:29.678Z","etag":null,"topics":["markdown-editor","markdown-previewer","tui-editor","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=keshan.markdown-live","language":"CSS","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/keshann93.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-07-05T09:49:29.000Z","updated_at":"2023-09-30T17:02:18.000Z","dependencies_parsed_at":"2023-08-18T18:38:01.946Z","dependency_job_id":null,"html_url":"https://github.com/keshann93/markdown-live","commit_stats":null,"previous_names":["keshann93/markdown-live"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keshann93%2Fmarkdown-live","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keshann93%2Fmarkdown-live/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keshann93%2Fmarkdown-live/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/keshann93%2Fmarkdown-live/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/keshann93","download_url":"https://codeload.github.com/keshann93/markdown-live/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251651221,"owners_count":21621702,"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":["markdown-editor","markdown-previewer","tui-editor","vscode-extension"],"created_at":"2024-10-22T09:43:39.828Z","updated_at":"2025-04-30T05:47:06.065Z","avatar_url":"https://github.com/keshann93.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e📝 Markdown Editor \u0026amp; Previewer\n\u003c/h1\u003e\n\n##### Markdown-live introduces a Markdown editor \u0026 previewer into Visual Studio Code.\n\n![intro](https://raw.githubusercontent.com/keshann93/markdown-live/master/banner.png)\n\n![Visual Studio Marketplace Version](https://vsmarketplacebadge.apphb.com/version/keshan.markdown-live.svg)\n![Visual Studio Marketplace Installs](https://vsmarketplacebadge.apphb.com/installs/keshan.markdown-live.svg)\n![Visual Studio Marketplace Downloads](https://vsmarketplacebadge.apphb.com/downloads/keshan.markdown-live.svg)\n\n## Introduction\n\n- Markdown Live is an extension that provides you with many useful functionalities including a live editor with useful options\n- A lot of its ideas are inspired by [Markdown Preview Style](https://github.com/mjbvz/vscode-github-markdown-preview-style) and [Unotes](https://github.com/ryanmcalister/unotes).\n- Feel free to ask questions, [post issues](https://github.com/keshann93/issues), submit pull request, and request new features.\n- For more information about this project and how to use this extension, please check out our Functionalities section⬇︎\n\n## Features\n\nMarkdown-live supports the followings\n\n- 💅 Renders instantly any `markdown/.md` document with its content.\n- 🎨 markdown-live editor comes with supportive tools/extension accompanied to edit markdown content in an efficient manner\n- 🌈 Supports rendering of multiple `.md` files\n- 🌏 Instantly syncs the changes made in either of two panels (markdown editor and text-document) across seamlessly\n- 🌟 Editor supports shortcut keys for the toolbar, please check the Keybindgs section for more information\n- 🌟 Editor supports set a configurations defined, please check the Workspace configuration section for more information\n- 🌟 auto scroll syn support is been added\n- 🌟 copy \u0026 paste of image support is been additionally added along with other functionalities that comes with tui-editor\n- 💥 lightweight custom editor extension for markdown: [![Only 883 Kb](https://badge-size.herokuapp.com/keshann93/markdown-live/master/markdown-live-1.2.1.vsix)](https://github.com/keshann93/markdown-live/blob/master/markdown-live-1.2.1.vsix)\n- ⚡️ Check [tui.editor](https://github.com/nhn/tui.editor) for more information and config changes.\n\n## Getting started\n\n- Install the [Markdown-live](https://marketplace.visualstudio.com/items?itemName=keshan.markdown-live) extension in VS Code\n- After opening a `markdown/.md` file, click on the \u003cimg src=\"https://raw.githubusercontent.com/keshann93/markdown-live/master/icons/tiny-icon.png\" width=\"20px\"\u003e icon to toggle the side-bar\n- Place your cursor in the markdown content\n- You should see the sidebar tries to render the markdown content\n\n###### Functionality Demo\n\n\u003cimg src=\"https://raw.githubusercontent.com/keshann93/markdown-live/master/assets/markdown-live-demo.gif\"\u003e\n\n###### Themes Demo\n\n\u003cimg src=\"https://raw.githubusercontent.com/keshann93/markdown-live/master/assets/markdown-live-demo1.gif\"\u003e\n\n###### Multi Document Render Demo\n\n\u003cimg src=\"https://raw.githubusercontent.com/keshann93/markdown-live/master/assets/markdown-live-demo2.gif\"\u003e\n\n## Command Configurations\n\n| Command            | Description             |\n| ------------------ | ----------------------- |\n| `showMarkdown`     | Toggle Markdown panel   |\n| `toggleScrollSync` | Toggle Scroll Sync Mode |\n\n- can be executed by opening the command pallete (ctr+shift+p) and type the command to select it and execute\n\n## Workspace Configurations\n\n| Name                                 | Description                                                                    | Default value  |\n| ------------------------------------ | ------------------------------------------------------------------------------ | -------------- |\n| `automaticallyShowPreviewOfMarkdown` | Automatically shows preview once the markdown/.md file gets opened up          | true(boolean)  |\n| `syncScroll`                         | Automatically sync the scroll of both editor and doc                           | true(booelan)  |\n| `display2X`                          | Display toolbar buttons of the editor at 2X size                               | false(boolean) |\n| `convertPastedImages`                | Convert pasted images to local files, if not it will show in base64 format     | true(boolean)  |\n| `mediaFolder`                        | The folder where images are saved relative to the markdown file project folder | .media(string) |\n\n- above values are easily configurable through `File -\u003e Preferrences -\u003e settings`\n\n## Keybindings\n\n| Shortcuts                                              | Functionality           |\n| ------------------------------------------------------ | ----------------------- |\n| \u003ckbd\u003ectrl + alt + 1\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 1\u003c/kbd\u003e | Heading 1               |\n| \u003ckbd\u003ectrl + alt + 2\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 2\u003c/kbd\u003e | Heading 2               |\n| \u003ckbd\u003ectrl + alt + 3\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 3\u003c/kbd\u003e | Heading 3               |\n| \u003ckbd\u003ectrl + alt + 4\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 4\u003c/kbd\u003e | Heading 4               |\n| \u003ckbd\u003ectrl + alt + 5\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 5\u003c/kbd\u003e | Heading 5               |\n| \u003ckbd\u003ectrl + alt + 6\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 6\u003c/kbd\u003e | Heading 6               |\n| \u003ckbd\u003ectrl + alt + 0\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + 0\u003c/kbd\u003e | Normal                  |\n| \u003ckbd\u003ectrl + alt + b\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + b\u003c/kbd\u003e | Bold                    |\n| \u003ckbd\u003ectrl + alt + i\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + i\u003c/kbd\u003e | Italic                  |\n| \u003ckbd\u003ectrl + alt + r\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + r\u003c/kbd\u003e | Strike                  |\n| \u003ckbd\u003ectrl + alt + t\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + r\u003c/kbd\u003e | Task                    |\n| \u003ckbd\u003ectrl + alt + u\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + u\u003c/kbd\u003e | Unordered List          |\n| \u003ckbd\u003ectrl + alt + o\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + o\u003c/kbd\u003e | Ordered List            |\n| \u003ckbd\u003ectrl + alt + q\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + q\u003c/kbd\u003e | BlockQuote              |\n| \u003ckbd\u003ectrl + alt + h\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + h\u003c/kbd\u003e | Inline Code (highlight) |\n| \u003ckbd\u003ectrl + alt + c\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + c\u003c/kbd\u003e | Code Block              |\n| \u003ckbd\u003ectrl + alt + l\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + l\u003c/kbd\u003e | Horizontal Line         |\n| \u003ckbd\u003ectrl + alt + n\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + n\u003c/kbd\u003e | Indent                  |\n| \u003ckbd\u003ectrl + alt + m\u003c/kbd\u003e/\u003cbr\u003e\u003ckbd\u003ecmd + alt + m\u003c/kbd\u003e | Outdent                 |\n\n## Acknowledgment\n\n[tui.editor](https://github.com/nhn/tui.editor) is integrated as the markdown editor\n\n## Changelog\n\nPlease check the [Releases](./CHANGELOG.md) \\| [Github](https://github.com/keshann93/releases) page of this project.\n\n## Contributing\n\nHave a look at our [contribution guide](./contributing.md).\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003ctable\u003e\n\u003ctbody\u003e\u003ctr\u003e\u003ctd align=\"center\"\u003e\u003ca href=\"http://keshann93.github.io\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/12506034?v=4\" width=\"100px;\" alt=\"\"\u003e\u003cbr\u003e\n\u003csub\u003e\u003cb\u003eKeshan Nageswaran\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003ca href=\"https://github.com/keshann93/semantic-live/commits?author=keshann93\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#design-keshann93\" title=\"Design\"\u003e🎨\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n\n## License\n\n[MIT License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeshann93%2Fmarkdown-live","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeshann93%2Fmarkdown-live","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeshann93%2Fmarkdown-live/lists"}