內容簡介
這是一個 WordPress 外掛,可使用短碼 [external_markdown] 從外部網站(例如 GitHub、GitLab 等)嵌入 Markdown 文件到 WordPress 內容中。可能的使用情況是在 WordPress 網站上顯示單一事實來源(如 GitHub 存儲庫)的內容。
功能特色
內嵌其他網站上任何公開可訪問的 Markdown 檔案
使用公共且免費的 GitHub API將 Markdown 轉換為 HTML(有負載限制,所以不要過度使用)
支援快取(可以設置從源頭獲取檔案的頻率,預設是每小時一次)
可自定 Markdown 容器的 CSS 類別以調整樣式
使用說明 / 範例
下載並解壓縮或複製此存儲庫到您的 wp-content/plugins 文件夾中,使 PHP 檔案位於 wp-content/plugins/external-markdown/external-markdown.php。
如果您使用 Guttenberg 編輯器,首先需要添加「短碼」塊。如果您使用傳統編輯器,可以立即使用短碼。
簡單內嵌
url 參數接受您希望嵌入的 Markdown 檔案的 URL。在使用 GitHub、GitLab 等時,請確保使用原始的 URL。
[external_markdown url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]
調整快取持續時間
ttl 參數控制使用快取版本的持續時間,直到再次獲取。值以秒為單位。因此,24 小時(24* 60 *60)的值為 86400。
[external_markdown ttl=86400 url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]
調整容器 CSS 類別
class 參數接受您希望設置的外部 Markdown 容器的類別名稱。容器的預設類別名稱為 class='external-markdown'。
[external_markdown class="my-classname" url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]
使用 GitHub、GitLab 等時注意
在嵌入來自 GitHub 或 GitLab 等 Git 托管服務的內容時,您需要確保使用正確的原始 Markdown URL。您可以在網頁檢視的右上角找到此 URL。
來源
本外掛受到偉大的 wordpress-markdown-git 外掛的啟發,後者有類似的功能,但使用 Git 提供者 API 擷取原始 Markdown 檔案- 比這個方法稍微複雜一些。
外掛標籤
開發者團隊
原文外掛簡介
This is a plugin for WordPress to embed Markdown files from external web sources (e.g. GitHub, GitLab, etc) into WordPress content using the shortcode [external_markdown]. A possible use case for this is to show content from a single source of truth (like a GitHub repository) on your WordPress website.
Features
Embed any publicly accessible markdown file from other websites
Uses the public and free GitHub API to transform Markdown to HTML (there is a rate limit – so don’t overdo it)
Caching support (so you can configure how often the file is being fetched from the source – default is a once per hour maximum)
Customise the CSS class of the markdown container to adjust styles
Instructions / Examples
Download and unpack or clone this repository into your wp-content/plugins folder, so the PHP file resides in wp-content/plugins/external-markdown/external-markdown.php.
If you use the Guttenberg editor, you need to add a “Shortcode” block first. If your’re using the classic editor, you can use the shortcode right away.
Simple embed
The url parameter takes the URL to the Markdown file you want to embed. Make sure to use the “raw” URL when you use GitHub, GitLab, etc.
[external_markdown url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]
Adjust caching duration
The ttl parameter controls how long the cached version is used, before it’s fetched again. The value is given in seconds. So 24 hours (24* 60 *60) result in a value of 86400.
[external_markdown ttl=86400 url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]
Adjust container CSS class
The class parameter takes your desired class name for the external markdown container. The default class name for the container is class='external-markdown'.
[external_markdown class="my-classname" url="https://raw.githubusercontent.com/pReya/wordpress-external-markdown/main/README.md"]
Attention when using GitHub, GitLab, etc.
When embedding content from Git hosting services like GitHub or GitLab, you need to make sure to use the proper “raw” markdown URL. You can find this URL in the upper right corner of the web view.
Attribution
This plugin was inspired by the great wordpress-markdown-git plugin, which serves a similar purpose, but uses the Git provider APIs to fetch the raw Markdown files – which is a little more complicated than this approach here.
