MarkdownQuote:簡化 Markdown 中的程式碼參照!

2023-07-22 18:01:08

MarkdownQuote:簡化 Markdown 中的程式碼參照!

這是 SourceCodeTrace 專案之一,通過在 IDE 中提供一種便捷的方式,快速複製包含程式碼來源 Markdown 程式碼塊。

SourceCodeTrace Project 幫助您在部落格、文章記錄的過程中,引入對應專案以及版本,行號等資訊,讓後續的讀者,通過參照來源,能夠進行更加深入的學習,在部落格或文章中引入程式碼塊時,儘量提供程式碼的來源資訊。

您是否厭倦了在 Markdown 檔案中手動格式化程式碼塊?MarkdownQuote 可以幫您節省不少麻煩!這個強大的 JetBrains 外掛讓程式碼參照變得輕而易舉,讓您專注於撰寫優秀的內容。

為什麼選擇 MarkdownQuote?

  • 安裝簡便:只需在 Jetbrains IDE 外掛搜尋中搜尋 "MarkdownQuote"。點選幾下滑鼠,您就能輕鬆安裝 MarkdownQuote。它支援所有 IDE 版本大於 193,確保與您喜歡的 Jetbrains IDE 相容。

  • 靈活的模板:MarkdownQuote 提供可自定義的模板,以滿足您獨特的需求。您可以輕鬆更改模板,按照自己的喜好進行調整。

  • 快捷方便:使用 MarkdownQuote,參照程式碼只需右鍵單擊!選擇 "Markdown Quote...",即可獲得所需的程式碼塊格式。

如何獲取 MarkdownQuote

您可以從多個來源獲取 MarkdownQuote:

如何使用 MarkdownQuote

  1. 選擇模板:從設定選單中選擇所需的模板,或者根據變數自定義模板。

  2. 參照程式碼片段:右鍵單擊所需的程式碼片段。

  3. 複製和貼上:MarkdownQuote 將生成正確格式的程式碼塊。只需複製並貼上到您的 Markdown 檔案中。

可用的模板

MarkdownQuote 提供多種模板,以滿足不同的使用情況。以下是一些範例:

Github 和 Gitee 均支援包含版本,具體行數的永久連結(permalink),MarkdownQuote 通過讀取當前倉庫的, , 以及當前檔案的行數,檔名等來生成對應的來源URL。

  1. 模板:語言 & 連結 & 程式碼

    ```java
    // 在這裡輸入您的程式碼
    ```
    [SourceFile.java#L100-L110](https://github.com/yourusername/repo/blob/master/SourceFile.java#L100-L110)
    
  2. 模板:語言 & 換行 & 高亮行 & 連結 & 程式碼

    ```java {100-110} (https://github.com/yourusername/repo/blob/master/SourceFile.java#L100-L110)
    // 在這裡輸入您的程式碼
    ```
    
  3. 模板:語言 & 程式碼

    ```java
    // 在這裡輸入您的程式碼
    ```
    

版本 1.0.2 的更新內容

  • 修復了一個問題,其中生成永久連結時使用了commitID而不是分支名。
  • 改進了預設模板,使用通用的 Markdown 語法,並新增了更多模板選項。

升級您的 Markdown 寫作體驗,使用 MarkdownQuote!立即獲取該外掛,在您的 Markdown 檔案中輕鬆參照程式碼。祝您編碼愉快!

如果你有更好的建議,可以在 Github ISSUE 給我提供更詳細的建議, 謝謝。