https://github.com/behindthemath/githubmarkdownlivepreview
Chrome extension to show a live preview when using Markdown on Github.
https://github.com/behindthemath/githubmarkdownlivepreview
chrome-extension github github-markdown markdown
Last synced: 3 months ago
JSON representation
Chrome extension to show a live preview when using Markdown on Github.
- Host: GitHub
- URL: https://github.com/behindthemath/githubmarkdownlivepreview
- Owner: BehindTheMath
- License: other
- Created: 2017-08-30T01:22:48.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-03T13:54:59.000Z (over 7 years ago)
- Last Synced: 2024-10-15T15:24:50.981Z (8 months ago)
- Topics: chrome-extension, github, github-markdown, markdown
- Language: TypeScript
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Markdown Live Preview
Github Markdown Live Preview is a Chrome extension which shows a live preview of the rendered Markdown on Github.
Github by itself does not show the rendered Markdown until you click the Preview tab.
This extension displays it as you type, after a 1 second delay.
The output is also sanitized, to protect from XSS attacks.
##### Supported pages
* New and edit issue
* New and edit Wiki page
* New and edit PR
##### Unsupported pages
* New and edit files
## Installation
* Install from the [Chrome Web Store](https://chrome.google.com/webstore/detail/fbpconkbjpdcmaacdbdijnfgaapannod/).
* Install as an unpacked extension:
1. Clone the repo.
2. Run `npm install`
3. Install in Chrome as an unpacked extension from the `lib-umd` folder
## Build
```
// Set up the environment
npm install
// Zip up for deployment
npm run zip
```
## Credits
[Showdown](https://github.com/showdownjs/showdown) - a Markdown to HTML converter
[sanitize-html](https://github.com/punkave/sanitize-html) - an HTML sanitizer
(See the [LICENSE](LICENSE) file for their licenses).
## License
MIT License
Copyright (c) 2017 Behind The Math
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.