瀏覽代碼

Update docs

simov 9 年之前
父節點
當前提交
12eaa1658f
共有 1 個文件被更改,包括 33 次插入36 次删除
  1. 33 36
      README.md

+ 33 - 36
README.md

@@ -2,50 +2,48 @@
 # Markdown Viewer / Chrome Extension
 
 
-## [Install][9]
+## [Install][chrome-store]
 
 
 ## Features
 
-- 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]
-- Syntax highlighted code blocks using [prism][6]
+- Built on top of the [marked][marked] compiler
+- Support for [GitHub Flavored Markdown][gfm]
+- Full control over the [compiler options][compiler-options]
+- 20 themes from [jasonm23][themes1] and [mixu][themes2]
+- Syntax highlighted code blocks using [prism][prism]
 - 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
-
-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
+- Built as [event page][event-page] - the extension is loaded only when it's needed
+- Open source
 
 
 ## 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].
+**gfm**         | `true`  | Enable GFM [GitHub Flavored Markdown][gfm].
+**tables**      | `true`  | Enable GFM [tables][gfm-tables]. This option requires the gfm option to be true.
+**breaks**      | `false` | Enable GFM [line breaks][gfm]. This option requires the gfm option to be true.
 **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.
+**sanitize**    | `false` | Sanitize the output. Ignore any HTML that has been input.
+**smartLists**  | `false` | 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.
 
 
 ## Markdown Syntax
 
-Navigate to this [URL][11] and play around with the extension's options.
+- Navigate to this [URL][syntax] and play around with the `Compiler Options`
+- Use the `Markdown/HTML` button to switch between raw markdown and rendered HTML
+- At any point click on the `Defaults` button to reset back the compiler's options
+
+
+## Local Files
+
+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
 
 
 ## License
@@ -73,14 +71,13 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-  [1]: https://github.com/chjj/marked
-  [2]: https://help.github.com/articles/github-flavored-markdown
-  [3]: https://github.com/chjj/marked#gfm
-  [4]: https://github.com/jasonm23/markdown-css-themes
-  [5]: https://github.com/mixu/markdown-styles
-  [6]: http://prismjs.com/
-  [7]: http://developer.chrome.com/extensions/event_pages.html
-  [8]: https://github.com/simov/markdown-viewer
-  [9]: https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk
-  [10]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables
-  [11]: https://raw.githubusercontent.com/simov/markdown-viewer/master/syntax.md
+  [marked]: https://github.com/chjj/marked
+  [gfm]: https://help.github.com/articles/github-flavored-markdown
+  [compiler-options]: https://github.com/chjj/marked#gfm
+  [themes1]: https://github.com/jasonm23/markdown-css-themes
+  [themes2]: https://github.com/mixu/markdown-styles
+  [prism]: http://prismjs.com/
+  [event-page]: http://developer.chrome.com/extensions/event_pages.html
+  [chrome-store]: https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk
+  [gfm-tables]: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#tables
+  [syntax]: https://raw.githubusercontent.com/simov/markdown-viewer/master/syntax.md