Startseite Erkunden Hilfe
Registrieren Anmelden
Apq
/
markdown-viewer
Mirror von https://github.com/simov/markdown-viewer.git
1
0
Fork 0
Dateien Issues 0 Wiki

Markdown Viewer / Browser Extension

Struktur: 066d056c85
Branches Tags
markdown-viewer
simov 066d056c85 Add theme layout styles vor 9 Jahren
background 9fa29a1fc3 Migrate the content script logic to mithril vor 9 Jahren
content 066d056c85 Add theme layout styles vor 9 Jahren
css 066d056c85 Add theme layout styles vor 9 Jahren
images 570b9a2b4e Remove dirty-shade image vor 10 Jahren
themes 066d056c85 Add theme layout styles vor 9 Jahren
vendor 0aefcd0b5a Remove jquery vor 9 Jahren
.editorconfig 552033301b Update project structure vor 9 Jahren
LICENSE 94ae5d5bb5 Update license vor 10 Jahren
README.md a03b2cdb61 Update docs vor 9 Jahren
manifest.json 066d056c85 Add theme layout styles vor 9 Jahren
syntax.md 552033301b Update project structure vor 9 Jahren

README.md

Markdown Viewer / Chrome Extension

Install

Features

  • Built on top of the marked compiler
  • Support for GitHub Flavored Markdown
  • Full control over the compiler options
  • 20 themes from jasonm23 and mixu
  • Syntax highlighted code blocks using 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 - the extension is loaded only when it's needed
  • Open source

Compiler Options

Option Default Description
gfm true Enable GFM GitHub Flavored Markdown.
tables true Enable GFM tables. This option requires the gfm option to be true.
breaks false Enable GFM line breaks. 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 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.

Markdown Syntax

  • Navigate to this URL 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

The MIT License (MIT)

Copyright (c) 2013-2016 Simeon Velichkov [email protected]

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.