|
@@ -7,28 +7,47 @@
|
|
|
|
|
|
|
|
## Features
|
|
## Features
|
|
|
|
|
|
|
|
-- built on top of the [marked][1] compiler
|
|
|
|
|
-- support for [GitHub Flavored Markdown][2]
|
|
|
|
|
-- full control over the [compiler options][3]
|
|
|
|
|
|
|
+- Built on top of the [marked][1] compiler
|
|
|
|
|
+- Support for [GitHub Flavored Markdown][2]
|
|
|
|
|
+- Full control over the [compiler options][3]
|
|
|
- 20 themes from [jasonm23][4] and [mixu][5]
|
|
- 20 themes from [jasonm23][4] and [mixu][5]
|
|
|
-- syntax highlighted code blocks using [prism][6]
|
|
|
|
|
-- settings synchronisation through google sync
|
|
|
|
|
-- built as [event page][7] - the extension is loaded only when it's needed
|
|
|
|
|
-- quickly switch between raw markdown and html
|
|
|
|
|
-- supported file extensions `markdown|mdown|mkdn|md|mkd|mdwn|mdtxt|mdtext|text`
|
|
|
|
|
-- [open source][8]
|
|
|
|
|
|
|
+- Syntax highlighted code blocks using [prism][6]
|
|
|
|
|
+- Settings synchronization through google sync
|
|
|
|
|
+- Quickly switch between raw markdown and html
|
|
|
|
|
+- Supported file extensions `markdown|mdown|mkdn|md|mkd|mdwn|mdtxt|mdtext|text`
|
|
|
|
|
+- Built as [event page][7] - the extension is loaded only when it's needed
|
|
|
|
|
+- [Open source][8]
|
|
|
|
|
|
|
|
|
|
|
|
|
## After Install
|
|
## After Install
|
|
|
|
|
|
|
|
-In order to view local files, make sure that the `Allow access to file URLs` checkbox is checked for the *Markdown Viewer* extension in `chrome://extensions`
|
|
|
|
|
|
|
+To enable the extensions for local files:
|
|
|
|
|
+1. Navigate to `chrome://extensions`
|
|
|
|
|
+2. Make sure that the `Allow access to file URLs` checkbox is checked for the `Markdown Viewer` extension
|
|
|
|
|
+
|
|
|
|
|
+To enable HTML tag rendering:
|
|
|
|
|
+1. Click on the small `m` icon in the right side of your browser's address bar
|
|
|
|
|
+2. Under the `Compiler Options` make sure the `sanitize` option is unchecked
|
|
|
|
|
+
|
|
|
|
|
+
|
|
|
|
|
+## Compiler Options
|
|
|
|
|
+
|
|
|
|
|
+Option | Default | Description
|
|
|
|
|
+:--- | :--- | :---
|
|
|
|
|
+**breaks** | `false` | Enable GFM [line breaks][2]. This option requires the gfm option to be true.
|
|
|
|
|
+**gfm** | `true` | Enable [GitHub flavored markdown][2].
|
|
|
|
|
+**pedantic** | `false` | Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
|
|
|
|
|
+**sanitize** | `true` | Sanitize the output. Ignore any HTML that has been input.
|
|
|
|
|
+**smartLists** | `true` | Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.
|
|
|
|
|
+**smartypants** | `false` | Use "smart" typograhic punctuation for things like quotes and dashes.
|
|
|
|
|
+**tables** | `true` | Enable GFM [tables][10]. This option requires the gfm option to be true.
|
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
## License
|
|
|
|
|
|
|
|
The MIT License (MIT)
|
|
The MIT License (MIT)
|
|
|
|
|
|
|
|
-Copyright (c) 2013-2015 Simeon Velichkov <[email protected]>
|
|
|
|
|
|
|
+Copyright (c) 2013-2016 Simeon Velichkov <[email protected]>
|
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
@@ -58,3 +77,4 @@ SOFTWARE.
|
|
|
[7]: http://developer.chrome.com/extensions/event_pages.html
|
|
[7]: http://developer.chrome.com/extensions/event_pages.html
|
|
|
[8]: https://github.com/simov/markdown-viewer
|
|
[8]: https://github.com/simov/markdown-viewer
|
|
|
[9]: https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk
|
|
[9]: https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk
|
|
|
|
|
+ [10]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables
|