Install: Chrome / Firefox / Edge / Opera / Brave / Chromium / Vivaldi
Additional documentation specific to Firefox
chrome://extensions
Details
buttonAllow access to file URLs
switch is turned onAll themes support the following width options:
auto
- automatically adjust the content width based on the screen sizefull
- 100% screen widthwide
- fixed at 1400pxlarge
- fixed at 1200pxmedium
- fixed at 992pxsmall
- fixed at 768pxtiny
- fixed at 576pxThe auto
option on the github
and github-dark
themes has a fixed width with a surrounding border identical to a rendered README.md
file for a repository hosted on github.com
CUSTOM
for Content ThemeYour custom theme will be minified automatically on upload and it can be up to 8KB in size.
You can add
<link rel="stylesheet" type="text/css" href="https://github.com/simov/markdown-viewer/blob/main/file:///home/me/custom-theme.css">
to your markdown document to speed up development while working on your theme. Custom theme example.
Full CommonMark support including GFM tables and strikethrough +
Option | Default | Description |
---|---|---|
abbr | false |
Abbreviation using *[word]: Text <abbr> |
attr | false |
Custom attributes using {} curly brackets |
breaks | false |
Convert new lines \n in paragraphs into line breaks <br> |
cjk | false |
Suppress linebreaks between east asian characters |
deflist | false |
Definition list <dl> |
footnote | false |
Footnotes [^1] [^1]: a |
html | true |
Enable HTML tags in source |
ins | false |
Inserted text ++a++ <ins> |
linkify | true |
Autoconvert URL-like text to links |
mark | false |
Marked text ==a== <mark> |
sub | false |
Subscript ~a~ <sub> |
sup | false |
Superscript ^a^ <sup> |
tasklists | false |
Task lists - [x] |
typographer | false |
Enable some language-neutral replacement + quotes beautification |
xhtmlOut | false |
Use / to close single tags (<br /> ) |
Option | Default | Description |
---|---|---|
autoreload | false |
Auto reload on file change |
emoji | false |
Convert emoji :shortnames: into EmojiOne images |
mathjax | false |
Render MathJax formulas |
mermaid | false |
Render Mermaid diagrams |
syntax | true |
Syntax highlighted fenced code blocks |
toc | false |
Generate Table of Contents |
When enabled the extension will make a GET request every second to markdown files hosted on:
file:///
URLs127.0.0.1
or IPv6 ::1
Convert emoji :shortnames: into EmojiOne images:
:smile:
will be converted to :smile: using EmojiOne images.😄
and ASCII emoji like :D
are not supported.The following MathJax delimiters are supported:
\(math\)
and $math$
\[math\]
and $$math$$
The following rules apply to your markdown content when MathJax is enabled:
$
in text that is not part of a math formula should be escaped: \$
\(
and \)
, and brackets: \[
and \]
is not supported. MathJax will convert anything between these delimiters to math formulas, unless they are wrapped in backticks: `\(`
or fenced code blocks.Render Mermaid diagrams wrapped in mmd
or mermaid
fenced code blocks:
```mmd
sequenceDiagram
```
Alternatively diagrams can be wrapped in HTML tags:
<pre><code class="mermaid">
sequenceDiagram
</code></pre>
Syntax highlighting for fenced code blocks:
```js
var hello = 'hi'
```
Alternatively code blocks can be wrapped in HTML tags:
<pre class="language-js"><code class="language-js">var hello = 'hi'</code></pre>
Full list of supported languages and their corresponding aliases to use.
Generates Table of Contents (ToC) based on the headers found in the markdown document.
Click on the Markdown Viewer icon and select Advanced Options
.
By default Markdown Viewer does not have access to any content:
To enable access to file URLs follow these steps.
In case access to local files was not enabled, an additional Allow Access
button will be present next to the File Access header:
Clicking on it will point you to the built-in management page for the extension where you can toggle the Allow access to file URLs
switch to enable it.
Access to individual sites can be enabled by copy/pasting a URL address into the Site Access text box and then clicking on the Add
button next to it:
Access to both
http
andhttps
protocols can be enabled by using a wildcard*://raw.githubusercontent.com
Access to all subdomains for a given hostname can be enabled by using a wildcard
https://*.githubusercontent.com
Access to all ports on
localhost
can be enabled by addinghttp://localhost
. Access to a specific port can be enabled by addinghttp://localhost:3000
Access to all sites can be enabled by clicking on the Allow All
button next to the Site Access header:
This is identical to adding the
*://*
pattern into the text box.
Each enabled origin has an option for content type header detection and path matching regular expression:
When this option is enabled the extension will check if the content-type
header with a value of text/markdown
, text/x-markdown
or text/plain
is present.
When this option is enabled the extension will check if the page URL matches the Path Matching RegExp.
The default regular expression is: \.(?:markdown|mdown|mkdn|md|mkd|mdwn|mdtxt|mdtext|text)(?:#.*|\?.*)?$
It is a simple regular expression that matches URLs ending with:
\.(?:markdown|mdown|mkdn|md|mkd|mdwn|mdtxt|mdtext|text)
(?:#.*|\?.*)?
The
?:
used in(?:match)
stands for non-capturing group and it is there for performance reasons.
You can modify the path matching regular expression for each enabled origin. The settings are being updated as you type.
The enabled origins are matched from most to least specific:
https://raw.githubusercontent.com
https://*.githubusercontent.com
*://raw.githubusercontent.com
*://*.githubusercontent.com
*://*
The matching origin with the highest priority will be picked and its header detection and path matching settings will be used to determine if the content should be rendered or not.
It is recommended to explicitly allow only the origins that you want the extension to have access to.
Click on the Remove
button for the origin that you want to remove. This removes the permission itself so that the extension can no longer access that origin.
The extension synchronizes your preferences across all of your devices if you have logged into your browser and enabled the sync feature. The list of your allowed origins is being synced too. However, the actual permissions that you grant using the consent popup cannot be synced.
In case you have enabled a new origin on some of your devices you will have to explicitly allow it on your other devices. In this case the origin will be highlighted and an additional Refresh
button will be present:
Only origins that needs to be refreshed will be highlighted. The extension cannot access highlighted origins unless you click on the Refresh
button.
In some cases access to previously allowed origins may get disabled. Make sure you check back the advanced options page or reload it and look for highlighted origins that needs to be refreshed.
Examples about the Markdown syntax and all features available in Markdown Viewer can be found on GitHub, GitLab and BitBucket:
Allow the appropriate remote origin or pull any of the above repositories and access it on the file:///
origin locally.
The following instructions applies for: Chrome, Edge, Opera, Brave, Chromium and Vivaldi.
Note that in any of the following cases you won't receive any future updates automatically!
markdown-viewer.crx
filechrome://extensions
markdown-viewer.crx
file into the chrome://extensions
pagemarkdown-viewer.zip
file and extract itchrome://extensions
Developer mode
switch is enabledLoad unpacked
button and select the extracted directorysh build/package.sh chrome
(or firefox
to build for Firefox)chrome://extensions
Developer mode
switch is enabledLoad unpacked
button and select the cloned directorychrome://extensions
Developer mode
switch is enabledLoad unpacked
button and select the cloned directoryThe MIT License (MIT)
Copyright (c) 2013-present, Simeon Velichkov simeonvelichkov@gmail.com (https://github.com/simov/markdown-viewer)
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.