mdjs-viewer

See Markdown JavaScript demos directly on github.com

mdjs-viewerとは何ですか?

mdjs-viewerはThomas Allmerによって開発されたChromeの拡張機能で、その主な機能は「See Markdown JavaScript demos directly on github.com」です。

拡張機能のスクリーンショット

screenshot
screenshot

mdjs-viewer拡張機能のCRXファイルをダウンロード

mdjs-viewer拡張子のファイルをcrx形式でダウンロードし、ブラウザにChrome拡張機能を手動でインストールするか、crxファイルを友達と共有して簡単にChrome拡張機能をインストールします。

拡張機能の使用方法

                        # Markdown JavaScript Viewer (mdjs-viewer)

[mdjs (Markdown JavaScript)](https://www.npmjs.com/package/@mdjs/core) allows to execute code and show interactive demos within your markdown documentation.

This extension takes this functionality and enables it directly on github.com.

You can see live demos in

- Github Markdown files (like README.md)
- Github Issues (incl. edit preview, new comment preview, new issue preview)
- ... more is planned but not yet implemented

## Security

Executing user code especially in github issues can be dangerous.
This extension isolates code executing as much as possible.
It can be considered as secure as any page that executes user code like codepen or jsfiddle.

The Security Measures are:

- not executing any code without user action (e.g. requires a click of a button first)
- shows demos/executes code within an iframe
  - that uses [sandbox](https://www.w3schools.com/tags/att_iframe_sandbox.asp) with the following settings `sandbox="allow-scripts"`
  - populates the iframe with a data uri
  - does not allow any requests (except unpkg) to got outside of the iframe

This prevents [all known attack vectors](https://github.com/open-wc/mdjs-viewer/issues/2). If you come up with new once please [report them](https://github.com/open-wc/mdjs-viewer/issues/new).

### Warning

In order to function this extension modifies the CSP (Content Security Policy) for github.com with the following rules:

- adds to script-src
  - `'unsafe-inline'` to execute code blocks within the mdjs iframe
  - `unpkg.com` to load user dependencies from within the mdjs iframe

## Demos

Enable the extension and visit the following pages

1. [Readme of demo-wc-card](https://github.com/daKmoR/demo-wc-card)
2. [Issues of demo-wc-card](https://github.com/daKmoR/demo-wc-card/issues/1)

## How does it work?

It adds a button `show demo ▹` to markdown pages and issues. Once you press it will get the raw md text which then gets pass though [mdjs](https://www.npmjs.com/package/@mdjs/core) and an extra plugin which replaces all imports (relative and bare imports) with [unpkg.com](https://unpkg.com/) urls with the `?module` flag. This way all dependencies can be directly loaded in the browser without the need of any service.

Finally we create an iframe with the content of the mdjs html and js output.

## Limits

In order to get the raw md content of an issues (only the first message not following comments) a request to api.github.com is required.
This request is only needed if you actually click on the `show demo ▹` button.
There is a hard limit of 60 anonymous api calls to github per hour.
For more an API key is needed. (You can not yet provide it to the extension 🙈 - feel free to open a feature request)                    

拡張機能の基本情報

名前 mdjs-viewer mdjs-viewer
ID ifkkmomkjknligelmlcnakclabgohafe
公式URL https://chromewebstore.google.com/detail/mdjs-viewer/ifkkmomkjknligelmlcnakclabgohafe
説明 See Markdown JavaScript demos directly on github.com
ファイルサイズ 256 KB
インストール数 51
現在のバージョン 0.0.4
最終更新日 2020-04-03
公開日 2020-04-03
開発者 Thomas Allmer
Eメール [email protected]
支払い方法 free
拡張機能のウェブサイト https://github.com/open-wc/mdjs-viewer
ヘルプページのURL https://github.com/open-wc/mdjs-viewer
対応言語 en
manifest.json
{
    "update_url": "https:\/\/clients2.google.com\/service\/update2\/crx",
    "name": "mdjs-viewer",
    "description": "See Markdown JavaScript demos directly on github.com",
    "version": "0.0.4",
    "manifest_version": 2,
    "permissions": [
        "webRequest",
        "webRequestBlocking",
        "https:\/\/github.com\/*"
    ],
    "content_scripts": [
        {
            "matches": [
                "https:\/\/github.com\/*"
            ],
            "js": [
                "esm-loaders\/esm-loader-content.js"
            ]
        }
    ],
    "web_accessible_resources": [
        "src\/*.js",
        "deps\/*"
    ],
    "content_security_policy": "script-src 'self' 'unsafe-eval' unpkg.com; object-src 'self'",
    "background": {
        "page": "esm-loaders\/esm-loader-background.html",
        "persistent": true
    },
    "browser_action": {
        "default_title": "mdjs",
        "default_icon": {
            "16": "images\/favicon-16x16.png",
            "32": "images\/favicon-32x32.png",
            "192": "images\/android-chrome-192x192.png",
            "512": "images\/android-chrome-512x512.png"
        }
    }
}