GitHubじゃ!Pythonじゃ!

GitHubからPython関係の優良リポジトリを探したかったのじゃー、でも英語は出来ないから日本語で読むのじゃー、英語社会世知辛いのじゃー

SublimeText-Markdown

MarkdownEditing – 優れた構文理解と優れたカラースキームを持つSublime Textの強力なMarkdownパッケージ

投稿日:

優れた構文理解と優れたカラースキームを持つSublime Textの強力なMarkdownパッケージ

MarkdownEditing

崇高なテキストのためのMarkdownプラグイン。 より堅牢な構文の強調表示と崇高なテキストのための便利なMarkdown編集機能を備えた、まともなMarkdownカラースキーム(明暗)を提供します。 3種類のフレーバーがサポートされています:Standard Markdown、 GitHubフレーバーMarkdown 、MultiMarkdown。

ダークイエローArcDarkテーマ、 第三者のテーマなどがあります。 テーマを変更する方法については、 設定セクションを参照してください。

概要

インストール

Package Control(推奨)または手動でMarkdownEditingをインストールすることができます。 パッケージコントロールは自動的にパッケージをダウンロードし、最新の状態に保ちます。 コードを調整する必要がある場合は手動でインストールする必要があります。

Sublime Text 2を使用している場合は、ネイティブパッケージを手動で無効にする必要があります。 これを行うには、STユーザー設定のignored_packagesリストにMarkdownを追加します。

"ignored_packages": [..., "Markdown"],

「構文ファイルのロード中にエラーが発生しました」というメッセージが表示される これを見てください。

パッケージコントロール

推奨されるインストール方法は、 Sublime Package Controlです。

  1. 崇高なパッケージコントロールをインストールする
  2. 崇高なテキストの中から、パッケージコントロールのコマンドパレット: CTRL SHIFT P (Windows、Linux)またはMacのCMD SHIFT Pを開きます。
  3. install packageを入力し、Returnキーを押します。 利用可能なパッケージのリストが表示されます。
  4. MarkdownEditingと入力してReturn MarkdownEditingます。 パッケージは適切なディレクトリにダウンロードされます。
  5. Sublime Textを再起動してインストールを完了します。 Markdownファイルとこのカスタムテーマを開きます。 以下の機能が利用できるようになりました。

手動インストール

  1. 崇高なテキストで、 “Preferences” – > “Browse Packages …”メニューを開きます。 これはSublime Text Packagesディレクトリです。
  2. このリポジトリを、Sublime Text PackagesディレクトリのMarkdownEditingディレクトリにダウンロードし、解凍または複製します。
  3. フォルダ構造は.../Sublime Text 3/Packages/MarkdownEditing/[files]ます。
  4. Sublime Textを再起動してインストールを完了します。 Markdownファイルを開きます。 以下の機能が利用できるようになりました。

特徴

ほとんどの機能にはコマンドパレットからアクセスできます。 Tools -> Command Palette...から起動することができTools -> Command Palette... MarkdownEditingコマンドは、 MarkdownEditing:始まります。 マークアップファイルが開いていてアクティブなときにのみ表示されます。

マークダウン機能

  • ペアリング
    • アスタリスクとアンダースコアは自動生成され、選択されたテキストをラップします。
    • 空のペアを開始してバックスペースを押すと、両方の要素が削除されます。
    • 空のペアとヒットスペースを開始すると、右の要素が削除されます。
    • バッククォートはペアになっています。 したがって`を入力すると`(cursor here)`展開され`(cursor here)`
  • リスト
    • リスト項目の最後にEnterキーを押すと、新しいリスト項目の箇条書きが自動的に挿入されます。
    • 空白のリスト項目をTabキーを押すとインデントされ、リストの箇条書き項目が別の項目に切り替わります(Orderは*-+が1つのサイクル内にあります)。
    • 空白のリスト項目のShift Tabを押すと、上記と同じ方法でインデントが取り消されます。
    • Sequential タブまたはShift Tabがサポートされています。
    • 自動箇条書き切り替えを無効にするか、設定ファイル( mde.list_indent_bullets )で使用する箇条書きを選択できます。
    • リスト項目にGFMタスクが含まれている場合、行の最後にEnterキーを押すと、空白の新しいタスクが続行されます。
  • ブロッククォート
    • ブロッククォート行の最後にEnterキーを押すと自動的にblockquoteが拡張されます。
    • テキストを選択して>キーを押すと、blockquoteに変換されます。 最初と最後の行を完全に選択する必要はありません。 部分選択も機能します。
  • リンク
    • 左のブラケットのペアリングは、選択範囲をなくし、リンクに[]または[]ペアを挿入できるポイントにカーソルを置きます。
    • リンク上にカーソルを置くと、右クリックして参照とURLの間をジャンプできます。
  • ナビゲーション
    • プロジェクトシンボルリストにマークダウンヘッダを表示します(ジャンプGoto -> Goto Symbol in Project... )。 #で始まるので、一目でマークダウンファイルに属していることがわかります。 また、 #の優先順位のためにリストの一番上に表示されます。
    • ヘッダーは、ドキュメントシンボルリスト( Goto -> Goto Symbol... )にも表示されGoto -> Goto Symbol...
    • あなたは現在のセクションをCtrl Tabで折り畳むことができます
    • 隣接する見出しの間を移動するには、 Find Next(Previous) HeadingFind Next(Previous) HeadingするFind Next(Previous) Headingコマンドを使用します。
  • 打ち間違い
    • ~~選択されたテキストを折り返します(取り消し線)。 たとえば、 “foo”という単語を選択して~押すと、結果は~~foo~~ます。
  • ヘッダ
    • 選択肢があるときに#入力すると#囲み、見出しにします。 複数回押すとハッシュが追加され、ヘッダーのレベルが上がります。 6ハッシュをヒットすると、次のプレスで0にリセットされます。 mde.match_header_hashesは、 #が両側にミラーリングされているか、ラインの先頭にあるかを判断します。
    • ハッシュマークで始まる行の最後にreturnを入力すると、タイトルに閉じるハッシュマークが挿入されます。 Markdownでは必須ではありません。それは単なる審美的なものです。設定でmde.match_header_hashesオプションをenable(デフォルトでは無効)に変更することができます。
    • SetextスタイルのヘッダーはTabで完成させることができます。 つまり、 =または-文字だけを含む行にTabを入力すると、上の行の長さに一致するのに十分な文字が追加または削除されます。
    • 新しい文書は、最初のヘッダーに基づいて自動的に名前が付けられます。

Wikiの機能

Wikiリンクは、(wiki)単語を二重大括弧で囲むことで定義されます。例:

[[SampleWikiPage]]

ユーザは崇高なコマンドを使ってwikiページをopenことができます。 これにより、現在の開いているファイルのディレクトリ(およびサブディレクトリ)に一致する名前とマークダウン拡張子を持つファイルが検索されます。 たとえば、前のwikiリンクを開くと、次の名前のファイルが検索されて開きます。

SampleWikiPage.md

wikiページがまだ存在しない場合は、ページ名と一致するヘッダーが作成されます。 ただし、ファイルが実際にファイルシステム上に作成されるのは、ユーザーによって保存されるときだけです。

ユーザーはlist back linkslist back links 、もちろんそれらを開くことができます。 戻るリンクは、現在のページを参照するページです。 これにより、ページを個人のwikiにまとめることができます。 一般的な手法は、 タグ wikiページを定義し、ページの下にあるタグページへの参照としてページの任意のタグをリストすることです。たとえば、次のようにします。

[[TagSyntax]] [[TagDev]] [[TagPython]]

これにより、ユーザは、タグページを開き、すべてのバックリンクをリストすることによって、特定のタグを有するすべてのページをリストすることができる。

Journal wikiページもサポートされています。 ジャーナル・ページは、現在の日付と一致する名前のwikiページです。

最後に、ホームページを開くコマンドが提供されHomePageHomePageという名前のwikiページです。

キーバインディング

OS X Windows / Linux 説明
⌘⌥V Ctrl Alt V クリップボードの内容を選択したテキストのインラインリンクとして作成またはペーストします。
⌘⌥R Ctrl Alt R クリップボードの内容を参照リンクとして作成またはペーストします。
⌘⇧K シフト 勝利 K クリップボードの内容を選択したテキストのインラインイメージとして作成またはペーストします。
⌘⌥B⌘⌥I Alt B Alt I これらは太字とイタリックにバインドされています。 彼らは選択の有無にかかわらず動作します。 選択がなければ、カーソルの下の単語を変換します。 これらのキーバインディングは、太字/斜体の場合は選択解除を解除/統一します。
^ 1 ... 6 Ctrl 1 ... 6 これらは、見出しに対応する数のハッシュマークを追加します。 空白行と選択したテキストを上記の見出しツールと連動して処理します。 既存の見出し全体を選択すると、現在のハッシュマークが削除され、要求した見出しレベルに置き換えられます。 このコマンドはmde.match_header_hashes設定を優先します。
⌥⇧6 Alt Shift 6 脚注を挿入します。
⇧Tab シフトタブ 現在のセクションを折り畳む/展開する。
^ タブ Ctrl Shift Tab 特定のレベルの見出しの下にすべてのセクションを折りたたみます。
⌘⌥PageUp⌘⌥PageDown Ctrl Alt PageUp Ctrl Alt PageDownを シフトします。 同じかそれ以上のレベルの前/次の見出しに移動する
⌘⇧PageUp⌘PageDown Ctrl Shift PageUp Ctrl PageDownを シフト 前/次の見出しに移動する
⌘⌥H Ctrl Shift H ホームページを開く
⌘⌥D Ctrl Shift D カーソルの下のwikiページを開く
⌘⌥J Ctrl Shift J 今日のジャーナルページを開く
⌘B Ctrl Shift B リストのリンクを戻す

GFM固有の機能

GFMは、GitHub Flavored MarkdownがMarkdownの方言であり、現在GitHub.comとGitHub Enterpriseのユーザーコンテンツでサポートされていることを意味します。 それはいくつかのユニークな特徴があります

単語の下線は太字またはイタリック体ではありません。

フェンスされたコードブロックは、内部で構文の強調表示を取得します。

キーボードショートカットはGitHubのようにハイライト表示されます:

取り消し線はサポートされています:

コマンドパレットのコマンド

Tools -> Command Palette...からコマンドパレットを起動できTools -> Command Palette... MarkdownEditingコマンドは、 MarkdownEditing:始まります。 マークアップファイルが開いていてアクティブなときにのみ表示されます。

一般的なコマンド

  • 下線付きヘッダーを修正するすべてのsetextスタイルのヘッダーを調整して、ヘッダーテキストの長さに合わせて必要に応じて=または-文字を追加または削除します。
  • 下線付きヘッダーをATXに変換すべてのsetextスタイルヘッダーをATXスタイルヘッダーに変換します。 何かが選択されている場合は、選択範囲内のヘッダーのみが変換されます。そうでない場合、変換はビュー全体に適用されます。
  • Markdown Lintローカルのリンターを使用して現在のMarkdownファイルに対してlintを実行します。 lintルールを参照してください。 lintingルールのいくつかは、ユーザー設定ファイルを使用してカスタマイズできます。
  • Run markdownlint markdownlintパッケージからmdlコマンドを実行します。 自分でインストールする必要があります。
  • カラースキームを変更…プレビューおよび使用するための組み込みのマークダウンカラースキームが一覧表示されます。
  • 箇条書きリストの種類を番号付きと箇条書きのスタイルに切り替えます

リンク、参考文献、脚注

  • 不足しているリンクラベルを追加参照されたリンクの使用[some link][some_ref][some link][some_ref][some link][] )について文書をスキャンし、それらがすべて定義されているかどうかを確認します。 定義されていないリンク参照がある場合、コマンドは自動的にファイルの一番下に定義スニペットを作成します。
  • Magic Footnotes Commandカーソルの下の単語の後に脚注を追加します。 カーソルが既に脚注にある場合、その定義または参照にジャンプします。
  • 欠落している脚注収集するすべての脚注の参照に定義スタブ(存在しない場合)を追加します。
  • ジャンプリファレンス定義と参照の間でカーソルをジャンプします。
  • 新しい参照カーソルの下に新しいリンクを追加します。
  • 新しいインラインリンクカーソルの下に新しいインラインリンクを追加します。
  • 新しいインラインイメージカーソルの下に新しいインラインイメージを追加します。
  • 新しいイメージカーソルの下に新しいイメージを追加します。
  • New Footnoteカーソルの下に脚注を追加します。
  • 参照の削除リンクの定義と参照を削除します。
  • 参照の整理現在のリンク参照の使用状況をソートして報告します。

折りたたみとナビゲーション

Remeberでは、 Ctrlキーを押しながらRキー(ドキュメント)とCtrlキーを押しながらShiftキーを押しながらRキーを押すと、すべてのヘッダーをすばやく確認できます。

  • 折りたたみ現在のセクションを切り替える現在のセクションを折り畳み /展開します。
  • フォールドレベル1-4セクション特定のレベルのヘッダーの下にすべてのセクションをフォールドします。
  • すべてのセクションを折りたたむ/展開することは自明です。
  • 次/前の見出しを検索する同じレベル以上のレベルまたは任意のレベルを見つけるオプションがあります

構成

このプラグインには、Markdown、GitHub、Markdown、MultiMarkdownの3種類のMarkdownフレーバーが含まれています。 デフォルトはGitHub風味のMarkdownです。 別のものをデフォルトとして設定する場合は、Markdownファイルを開き、メニューから「表示View > Syntax > Open all with current extension asを選択します。 あなたは終わった。

あなたはデフォルトの設定ファイルを見たいかもしれません。 彼らは次の場所にあります:

Packages/MarkdownEditing/Markdown.sublime-settings         [GitHub flavored Markdown]
Packages/MarkdownEditing/Markdown (Standard).sublime-settings
Packages/MarkdownEditing/MultiMarkdown.sublime-settings

デフォルト設定を上書きする場合は、 Preferences > Package Settings > Markdown Editingメニューを使用して、適切なユーザー設定ファイルを開くことができます。 各フレーバには異なる設定ファイルがあります。

太字とイタリックのマーカーは、STシェル変数を使用して構成できます。 Preferences > Package Settings > Markdown Editingメニューを使用して、デフォルト設定ファイルを表示できます。 それを無効にするには、その内容をメニューからユーザー設定ファイル( Packages/User/Bold and Italic Markers.tmPreferences )にコピー&ペーストして編集します。 それはかなり簡単です。

暗または黄色のテーマを有効にするには、これらの行のいずれかをフレーバーのユーザー設定ファイル( Packages/User/[flavor].sublime-settings )にPackages/User/[flavor].sublime-settings

"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-Dark.tmTheme",
"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-Yellow.tmTheme",
"color_scheme": "Packages/MarkdownEditing/MarkdownEditor-ArcDark.tmTheme",

すでに存在するテーマを使用したい場合は、上記と同じ方法で再度有効にすることができます。 そのテーマは、このプラグインで定義されているMarkdown構文のすべての部分を網羅していない可能性があります。

追加の色テーマ:

既定では、プラグインをインストールすると、これらの拡張子を持つファイルはMarkdown構文に割り当てられます: “md”、 “txt”、 “mdown”、 “markdown”、 “markdn”。 これらの拡張機能がMarkdownとして開かれないようにするには、次の手順を実行します。

  1. 右下の言語メニューをクリックしてください
  2. [現在の内線番号ですべて開く]を選択し、
  3. その拡張機能に適した構文を選択する

ヒント

私たちはWikiの ヒントセクションを維持しています 他の人から学びたり、あなたの経験を他の人と分かち合うためにそこに飛び乗る

WYSIWYGを有効にする

SublimeはWYSIWYG(あなたが見ているものはあなたが入手したものです)のエディタに2つの他のプラグインを設定することができます:

  1. マークダウンプレビュー( https://packagecontrol.io/packages/Markdown%20Preview
  2. ライブリロード( https://packagecontrol.io/packages/LiveReload

あなたが持っていない場合はそれらをインストールします。 その後、

  1. パレットを開く
  2. LiveReload:プラグインを有効/無効にする
  3. シンプルリロードを有効にする。

パレットを開いて「ブラウザでプレビュー」を選択すると、WYSIWYGエディタが表示されます。

トラブルシューティング

構文ファイルを読み込む際のエラー…

インストール後にこのエラーが発生しました: 構文ファイル “Packages / Markdown / Markdown.tmLanguage”の読み込み中にエラーが発生しました: パッケージ/ Markdown / Markdown.tmLanguageを開くことができませんか?

これは、インストール時に開いているマークダウンファイルによって発生します。 新しくインストールされたMarkdown構文に構文手動で変更する必要があります これに関する詳細については、以下の段落を読んでください。

:崇高なテキストには、Markdownのネイティブの小さなパッケージがあります。 ただし、MarkdownEditingを有効にすると、ネイティブパッケージによって競合が発生します。 このため、MarkdownEditingは自動的に無効にします。 MarkdownEditingには何も新しくないので、これは損失ではありません。 しかし、MarkdownEditingを無効にすると、手動でネイティブのものを有効にする必要があります(必要な場合)。

古いバージョンにロールバックする

最新のアップデートで望ましくない動作が発生した場合は、 問題のページでフィードバックをお待ちしています しかし、修正される前に、以前のバージョンにロールバックすることができます。 必要なバージョンを探してzipファイルをダウンロードし、 手動インストールガイドに従ってください

関連するプラグイン

既知のバグ

  • Setext形式のヘッダー( ===--- )はシンボルリストに表示されません。 これは、Sublime Textの制限が原因です( #158を参照)。 しかし、ヘッダーの存在を示すプレースホルダーを置くことができます。 Atxスタイルのヘッダー( # )を使用することをお勧めします。

  • マークダウンファイルを開いた状態で初めてインストールするとMarkdownEditingが予期せず動作することがあります。 これらのファイルを閉じて再オープンしてください。

貢献する

CONTRIBUTING.mdファイルを参照してください。

クレジット

MarkdownEditingはもともとBrett Terpstraによって作成されたもので、Sublime TextのMarkdownパッケージのさまざまなコレクションから最高の機能を統合するという目標を持つコミュニティプロジェクトになっています。 現在の開発はAli AyasFelix Haoによって率いられています。

Brettの関連ブログ記事:

このプラグインにはKnockdownのコードの一部が含まれています。

脚注のコマンドはJ. Nicholas Geistによって提出され、 geekabouttown作成さました

寄付

このプロジェクトの貢献者を個別にサポートすることができます。 すべての投稿者は、下の行にコンテンツを追加することを歓迎します。 注文はGitHubのユーザー名でアルファベット順に行われます。

ライセンス

MarkdownEditingは、 MITライセンスの下でリリースされます。







-SublimeText-Markdown
-, , ,

執筆者: