2021年4月5日月曜日

Markdown note

マークダウン.md --- title: Markdown note ---

1. Markdown

単純化したなマークアップ。HTMLの最小機能版。 マークダウンによる基本記述は、Markdown: Syntax：https://daringfireball.net/projects/markdown/syntax 実際は拡張されたmarkdownが多種ある。GitHub Flavored Markdown GFM がメジャーだと言われている。

1.1. マークダウンの表示とエディタ

基本的にはテキストエディタでさえあればマークダウンの記述は可能。拡張子は決まってない。mdの場合がほとんど。原則、html で表示する (RFC7763)。

1.1.1. Debian(debファイル)

debパッケージでインストール可能なエディタ兼プレビュー。

  • ghostwriter : サイドウィンドウに結果表示。
    ホーム https://wereturtle.github.io/ghostwriter/
    Debian buster では ghostwriter v1.7.4、latestは v1.8.1
    Debianで最新にmake してみた。ダウンロード先 source code。v1.7.4→v1.8.1にしたらテーブルの最後の行が閉じるようになった。

    $ sudo apt install g++ qt5-default qtbase5-dev libqt5svg5-dev qtmultimedia5-dev qtwebengine5-dev libhunspell-dev pkg-config libqt5concurrent5 qttools5-dev-tools
$ cd <your_ghostwriter_folder_location>
$ qmake
$ make
# make install      // デフォルトインストール先 /usr/local/bin/

別途、pandoc, discount, cmarkがインストールされていると、Sundown, Pandoc, Pandoc CommonMark, Pandoc GitHub-flavored Markdown, Pandoc PHP Markdown Extra, Pandoc MultiMarkdown, Pandoc Strict, Discount, cmark 型で各種エクスポートできる。

  • ReText : ソースとプレビュー表示。
    本来の Markdownに近い。Block codeは整形してくれない。

上記2つは、簡単にmarkdownをプレビュー見ながら入力して、html, pdf に出力できる。

  • code : マイクロソフトの汎用テキストエディタ Visual studio code。Debianのパッケージ名は code。

1.1.2. Remarkable

  • REMARLABLE https://remarkableapp.github.io/i かなり拡張されているので、他ではプレビューできないかも。Debian busterにremarkable_1.87_all.deb を入れようとしたら、gir1.2-webkit-3.0にダウングレードの必要があったので諦めた。

1.1.3. Typora

  • flatpakのflathub や snap 上で Typora をインストールする方法がある。

  • T for Linux に binary file Typora-linux-x64.tar.gz がある。

  • 直接 Typora からインストール。

    例
$ sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys BA300B7755AFCFAE
$ sudo add-apt-repository 'deb https://typora.io ./linux/ ' 
$ sudo apt-get update 
$ sudo apt-get install typora

1.1.4. Boostnote

  • Boost Noteに debファイルがある。GitHubのアカウントが必要。cloudサービス。有料版と無料版(100M)

1.1.5. Joplin

  • Joplin。クラウドサービス。debはないけどLinux インストール.sh

1.1.6. Atom

  • ATOM に debファイル。

1.1.7. Visual Stuido Code

Microsoftのテキストエディタ(略 VScode)。本家 Visual Studio Code

  • Debian の synapticsや aptでは、codeというパッケージ名をインストール。

  • 起動するには、

    • ファイル.mdを右クリック→アプリケーションで開く→Visual Studio Code
    • スタート→すべてのアプリケーション→ユーティリティー→Text Editor

  • メニューの日本語化

    2通りの方法

    1. メニューバー: View → Command Palette を開いて Configure Display Language で検索 → Install additional languages から Japanese Language Pack for Visual Studio Code をinstall して Restart Now

    2. 左サイドバーの田の字の欠けたアイコンをクリック → japanese で検索 → Japanese Language Pack for Visual Studio Code : install して Restart Now

  • プレビューを開いた状態で起動させる
    マークダウンファイル(md)を開くたびに右上のアイコンでプレビューオープンするのが面倒なら、拡張機能を利用して自動オープンにする。
    メニューバー→表示→拡張機能→ (検索) 'auto-open' : Auto-Open Markdown Preview をインストール

  • TOC table of contents 拡張機能使用時の問題
    VScodeの「EOL end of line 行末」が autoになっていると失敗する。linuxだと $ echo "" | od -c で行末確認できる。使用OSに従って unix系やOSXは \n、Windows系 \r\nにする。左下の歯車マークの設定から検索で'eol'で検索して変更。

  • MarkdownをHTMLで出力
    拡張機能インストールで対応。markdown-pdfや vscode-pandocなど

  • 目次 TOC table of contents
    #〜### H1〜H3で目次を作る。拡張機能 Markdown Toc (章番号の自動化も可能だけど内部参照と辻褄あわなくなったりする)、Markdown Preview Enhanced など。pandocでもTOC作成可能。

1.1.8. 番外

  • Kate : モードの切り替えでプログラミング入力に対応するKDEのテキストエディタ。kpartsplugin と KMarkdownWebViewPart でMarkdownのプレビュー可能なはずだけど現状では無理っぽい。 Katebuildで pandoc等のコマンドを通してmarkdown→htmlは可能 https://azaharblanca.blogspot.com/2021/04/kde-kate-md-html.html。

  • Okular : okular-extra-backends (と kpartsplugin)を入れると、Markdown(.md)が読める (Kateから呼び出せるらしい)ので、HTMLにエクスポートできる。
    参考 https://www.maketecheasier.com/convert-markdown-to-html-in-kate-text-editor/

  • vim エディタを使用してる場合。vim-voomのインストールでmarkdownのアウトラインが表示できる。

1.2. Markdownの HTML出力

1.2.1. markdown, mmark, marked コマンド

  • Debianでは、markdownパッケージをインストールするとターミナルから markdownコマンドで md形式のファイルを html出力できる。

    例 $ markdown sample.md > sample.html

    <body>の中身だけの sample.htmlが出来る。 詳細は man markdown。

    他に mmarkや node-marked (コマンドとしては marked) や pandocなど。

1.2.2. pandoc

  • pandocは、多くのテキストファイル形式を別形式に変換する。markdown→htmlも可能。

      md→htmlの例. -s standalone <head><body>html全体を作成
$ pandoc -s sample.md -o sample.html

  toc : table of contents 目次作成
$ pandoc -s --toc sample.md -o sample.html
  
  GitHub-flavored Markdown(gfm)タイプのhtml出力。
$ pandoc -s -r gfm sample.md -w html -o sample.html

    templateを入れることで、さらに拡張整形ができる。
    例えば https://github.com/jgm/pandoc/wiki/User-contributed-templates > HTML > Easy Pandoc Templates の clean_menu.html を使う場合、 ~/.pandoc/templates/　を作成してここにclean_menu.htmlを置いて、

    # templateの使用例
$ pandoc -s --toc --template=clean_menu.html sample.md -o sample.html

以上
Debian buster, KDE, plasmashell, VScode + Markdown TOC + Markdown PDF で試した個人的なメモ

By
ラベル: ,

0 件のコメント:

コメントを投稿

注: コメントを投稿できるのは、このブログのメンバーだけです。

登録: コメントの投稿 (Atom)