Markdeep Block

外掛說明

“Markdeep is ideal for design documents, specifications, README files, code documentation, lab reports, blogs, and technical web pages. Because the source is plain text, Markdeep works well with software development toolchains.”
— http://casual-effects.com/markdeep/

“Markdeep is a text formatting syntax that extends Markdown, and a JavaScript program for making it work in browsers. The two most powerful features are its ability to run in any web browser on the client side and the inclusion of diagrams.”
— https://casual-effects.com/markdeep/features.md.html

This plugin adds a gutenberg block supporting the markdeep language. The editor shows both a plaintext
area for composing the text, and a preview area to display the rendered block.

MathJax & CDN

In order to support MathJax features, the MathJax library is loaded from an external CDN (cdnjs/cloudflare).

MathJax.org does not collect, maintain, distribute, purchase, or sell personal data of any kind, and uses no cookies or other tracking
or advertising techniques.

Likewise, the MathJax software does not track you, and uses local storage only to maintain your preferences as set by the MathJax contextual menu.

— https://www.mathjax.org/#privacy-statement

If you do not change the CDN you will be subject to cloudflare’s terms & privacy policy.

This CDN can be changed with a one-line script. (Alternately, use the WordPress plugin file editor to uncomment a similar line in
markdeep-block.php). In the future this should be an exposed configuration option.

To override the CDN use:

`php

// Markdeep currently uses version 2.7.6
add_filter( ‘markdeepblock_mathjax_url’, fn($u) => ‘https://cdn.jsdelivr.net/npm/mathjax@2.7.6/unpacked/MathJax.js?config=TeX-AMS-MML_HTMLorMML’ );
`

Planned features

  • UI to configure CDN for JS resources (Markdeep, MathJax).
  • Configurable style per block.
  • Drop-down style selection of styles (globally & per-block).
  • Get MathJax commands working in editor. (MathJax currently works in posts).
  • Markdeep specific LaTeX/MathJax macros. (e.g. θ₀, θ₁, etc.)
  • Configurable MathJax macros.
  • Optional Table of Contents (currently suppressed)

Logo

The logo is derived from Dustin Curtis’s https://github.com/dcurtis/markdown-mark.

適用於區塊編輯器

這個外掛提供 1 個可供 Gutenberg/區塊編輯器使用的區塊。

  • Markdeep Block Markdeep Block is a WordPress plugin for adding Gutenberg blocks supporting Markdeep syntax.

安裝方式

This plugin can be installed through the normal processes: the WordPress plugin directory, (hopefully) the WordPress block
directory, and a manual installation.

  1. Upload the plugin files to the /wp-content/plugins/markdeep-block directory, or install the plugin through the WordPress plugins screen directly.
  2. Activate the plugin through the ‘Plugins’ screen in WordPress.

常見問題集

Can you make diagrams with this?

Yes, in fact it’s all done with text! See the markdeep site for specific
examples.

使用者評論

這個外掛目前沒有任何使用者評論。

參與者及開發者

以下人員參與了開源軟體〈Markdeep Block〉的開發相關工作。

參與者

將〈Markdeep Block〉外掛本地化為台灣繁體中文版

對開發相關資訊感興趣?

任何人均可瀏覽程式碼、查看 SVN 存放庫,或透過 RSS 訂閱開發記錄

變更記錄

0.0.1

  • Release