https://github.com/igtm/mdclient
Markdown Viewer Chrome Extension for Github
https://github.com/igtm/mdclient
chrome-extension markdown markdown-previewer markdown-viewer rust wasm
Last synced: 28 days ago
JSON representation
Markdown Viewer Chrome Extension for Github
- Host: GitHub
- URL: https://github.com/igtm/mdclient
- Owner: igtm
- Created: 2023-01-04T11:13:47.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-15T11:51:01.000Z (over 3 years ago)
- Last Synced: 2024-04-18T16:14:36.062Z (about 2 years ago)
- Topics: chrome-extension, markdown, markdown-previewer, markdown-viewer, rust, wasm
- Language: JavaScript
- Homepage: https://chrome.google.com/webstore/detail/mdclient/jfbecbjclfjnbbblkidiliaoonknndlj
- Size: 16.2 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MDClient
Markdown Viewer Chrome Extension for Github
# Why Chrome Extension?
If you write Documentations with markdown based Document generation tool(eg. Hugo, Zola, Docusaurus),
you have to host the generated static files on somewhere.
Moreover, if your project is private, you may have to set some authentication logic (Basic ..etc)
so I take a stance in `Hostingless Documentation`.
All you have to do is just write markdown and push on Github.
if someone want to see it, just give them Github Read permission of the repo and you can see it through this extension.
# Concepts
- Hostingless Documentation Tool
- Markdown file only (Compatibility. no required configs)
- Markdown not only for Tech but also for Biz person
# Supported features
- [x] [CommonMark](https://commonmark.org/)
- [x] [github flavored markdown](https://github.github.com/gfm/)
- [x] Github Private Repository (Github OAuth App)
- [x] [mermaid.js](https://mermaid.js.org/#/)
- [x] code syntaxhighlighting with [highlightjs](https://highlightjs.org/)
- [x] Darkmode