【リリース】Markdownエンジンの改善など

2021年06月16日(水) リリース情報

いつもNotePMをご利用いただきありがとうございます 😊
本日は機能改善と不具合修正のお知らせです。

今回のリリース内容 📣

  • Markdownエンジンの改善
  • 「TLS 1.0」「TLS 1.1」暗号化の無効化について
  • 不具合の修正

Markdownエンジンの改善

Markdownエンジンをより標準的なものに変更しました。

これにより、Markdown記法を採用する各種サービスとの連携性およびMarkdown変換の信頼性が向上しました。

一方で、これまでご利用いただいていた一部のMarkdown記法が使えなくなるケースもございます。今回のリリースで、ページの表示に違いを感じられた場合は、後述する Markdown記法の変更点 をご参照いただくか、サポートまでお問い合わせいただければと存じます。

MarkdownおよびMarkdownエンジンについて

Markdown(マークダウン) とは、# 見出し**太文字** のように、シンプルな書き方で文書構造や文字装飾を表現するための言語です。NotePMでは、ページの内容を記述するための言語(記法)として、このMarkdownを採用しています。

Markdownの記法で入力されたテキスト文は、Markdownエンジン によって各種の装飾が施されたWebページ(HTML文書)に変換されます。このMarkdownエンジンには様々な種類があり、エンジンごとに利用可能な記法や振る舞いが異なります。

今回のリリースでは、このMarkdownエンジンをより標準的なものに変更することで、他の文書管理サービスで蓄積されたMarkdownテキストをNotePMで利用するといったこと(あるいはその逆)をより容易におこなえる状態を目指しました。

Markdown記法の変更点

Markdownエンジンの変更により、これまで利用できていた一部のMarkdown記法が期待通りに変換されない場合があります。その代表的な例と対策についてご説明します。

変更後のMarkdown記法についてより詳しい情報をお求めの場合は、今回NotePMで採用したMarkdownエンジンである CommonMark に関する各種情報をご参照いただければ幸いです。

参考: CommonMark Spec

半角スペースの有無に厳格になりました

見出しは # の後ろに1つ以上の半角スペースが必要です。

#
#

変換結果

見出し

逆に、太文字や取り消し線には半角スペースを含めないように記述する必要があります。

** **
~~ ~~
****
~~~~

変換結果
太文字
取り消し線

テーブル記法の判定に厳格になりました

ヘッダー行(テーブル記法の1行目と2行目)の列数が揃っていないと期待通りに変換されません。

| 1 | 2 |
| --- |
| |

列数を揃えることでテーブルに変換されるようになります。

| 1 | 2 |
| --- | --- |
| | |

変換結果

タイトル1 タイトル2
りんご みかん

特定のHTMLタグとMarkdown記法との間に空行が必要になりました

Markdownテキストには、HTMLタグを埋め込むことができます。これにより、Markdown記法では表現することのできない文書構造や装飾の表現が可能となります。

今回のMarkdownエンジンの変更により、特定のHTMLタグに続けてMarkdown記法を使用する場合には、HTMLタグとMarkdown記法との間に空行を挟むことが必要となりました。

例えば、アコーディオン(detailsタグ)に続けて見出し(###)を配置したい場合に、

<details>
<summary></summary>
</details>
###

のように記述すると、detailsタグ とMarkdownの見出し記法との間に空行が挟まれていないため、見出しとして変換されません。間に空行を挟むと期待通りに変換されるようになります。

<details>
<summary></summary>
</details>
###

変換結果

タイトル

詳細

見出し

また、同様にアコーディオン内でMarkdown記法を使用する場合、

<details>
<summary></summary>
- 1
- 2
</details>

のように記述すると、summaryタグとMarkdownのリスト記法との間に空行が挟まれていないため、アコーディオン内のリストは変換されません。先ほどの例と同様に、間に空行を挟むと期待通りに変換されます。

<details>
<summary></summary>
- 1
- 2
</details>

変換結果

タイトル
  • リスト1
  • リスト2

空行で区切る必要のあるHTMLタグの例

details, summary, div, iframe, p, table など。
詳細については、CommonMark Spec の関連仕様 をご参照ください。

リスト、引用の省略記法の一部振る舞いが変わりました

リスト、引用の省略記法について

リスト記法を使用する際、

* 1
1
* 2
2

のように、* リスト記法 に続く行のインデント(半角スペースの数)を揃えると、

変換結果

  • リスト1
    リスト1の内容

    • リスト2
      リスト2の内容

のように、リスト記法に続く行がリストの一部として変換されますが、以下のようにインデントを省略した場合でも、インデントがあるものとして同様に変換されます。

* 1
1
* 2
2

変換結果

  • リスト1
    リスト1の内容

    • リスト2
      リスト2の内容

これは、通常の * リスト 記法以外に、1. 番号付きリスト- [] チェックリスト および、> 引用 記法でも同様の振る舞いとなります。

>

変換結果

引用
この行も引用になります

リスト、引用の省略記法に関する変更点
特定のHTMLタグ

リスト、引用に特定のHTMLタグが続く場合は、省略記法が適用されず、明示的にインデントを揃えることが必要となりました。

img
*
<img src="https://notepm.jp/assets/img/apple-touch-icon-120x120.png">

変換結果

  • リスト

このように、画像がリストの外に表示されます。これをリストの一部として表示するためには、リスト記法の行とインデントを揃えます。

*
<img src="https://notepm.jp/assets/img/apple-touch-icon-120x120.png">

変換結果

  • リスト

img タグの他に同じような変更が適用されるタグとして、details, summary, div, iframe, p などがあります。HTMLタグのブロックが複数行にまたがる場合は、

HTML
*
<details>
<summary></summary>
</details>

のようにHTMLブロック全体のインデントを揃える必要があります。

種別の異なるリスト記法

種別の異なるリスト記法が続いた場合、

*
1.

従来は、

従来の変換結果

  • 通常のリスト
    1. 番号付きリスト

のように、2行目に省略記法が適用されることで、番号付きリストが通常のリストの一部として変換されていました。これが、省略記法が適用されなくなり、

現在の変換結果

  • 通常のリスト
  1. 番号付きリスト

のように別のリストとして変換されるようになりました。従来と同様の変換結果とするには、インデントを揃えます。

*
1.

変換結果

  • 通常のリスト
    1. 番号付きリスト

テーブル記法

リストや引用にテーブル記法が続いた場合、

*
| 1 | 2 |
| --- | --- |
| | |

従来は、リストの後に独立したテーブルが配置されるかたちで変換されていましたが、テーブル記法に省略記法が適用され、テーブルが(テーブル変換されない状態で)リストの一部として変換されるようになりました。

変換結果

  • リスト
    | タイトル1 | タイトル2 |
    | — | — |
    | りんご | みかん |

こちらを従来通り、独立したテーブルとして表示するには、空行を挟みます。

*
| 1 | 2 |
| --- | --- |
| | |

変換結果

  • リスト
タイトル1 タイトル2
りんご みかん

テーブルをリストの一部として表示する場合は、インデントを揃えます。

*
| 1 | 2 |
| --- | --- |
| | |

変換結果

  • リスト
    タイトル1 タイトル2
    りんご みかん

 

「TLS 1.0」「TLS 1.1」暗号化の無効化について

セキュリティ強化を目的として下記の日程で、
インターネット通信暗号化方式 TLS1.0/1.1 を無効化することになりました。

実施日時

2021年6月21日(月) 10:00

影響範囲

TLS1.2 に対応していない古いブラウザー、パソコン、スマートフォン、フィーチャーフォンからは、サイトへの接続ができなくなります。

「TLS 1.0」「TLS 1.1」暗号化の無効化について | NotePM

 

不具合の修正

以下の不具合を修正しました。

  • 「次のページ」「前のページ」が正しくない場合がある
  • 画像を直接コピー&ペーストすると、添付ファイル一覧のサムネイルに画像が表示されない
  • 埋め込み画像が2px縮んで表示される
  • テーブルエディターで、セルにテキストがある状態で編集(上書き)すると、1文字目がダブって表示される

 

導入事例インタビューのご紹介 📣

【導入事例】気軽に社内ナレッジを蓄積する場を構築。日報を通じて社内コミュニケーションが活発に!- 株式会社47CLUB

 

引き続きNotePMをよろしくおねがいいたします!

twitter0428