blog-engine-06-pelican 靜態網站生成 支援 markdown 和 reST 語法

老马啸西风發表於2024-03-26

擴充閱讀

blog-engine-01-常見部落格引擎 jekyll/hugo/Hexo/Pelican/Gatsby/VuePress/Nuxt.js/Middleman 對比

blog-engine-02-透過部落格引擎 jekyll 構建 github pages 部落格實戰筆記

blog-engine-02-部落格引擎jekyll-jekyll 部落格引擎介紹

blog-engine-02-部落格引擎jekyll-jekyll 如何在 windows 環境安裝,官方文件

blog-engine-02-部落格引擎jekyll-jekyll SEO

blog-engine-04-部落格引擎 hugo intro 入門介紹+安裝筆記

blog-engine-05-部落格引擎 Hexo 入門介紹+安裝筆記

blog-engine-06-pelican 靜態網站生成 官方文件

blog-engine-06-pelican 靜態網站生成 windows 安裝實戰

blog-engine-07-gatsby 建極速網站和應用程式 基於React的最佳框架,具備效能、可擴充套件性和安全性

blog-engine-08-vuepress 以 Markdown 為中心的靜態網站生成器

blog-engine-09-nuxt 構建快速、SEO友好和可擴充套件的Web應用程式變得輕鬆

blog-engine-10-middleman 靜態站點生成器,利用了現代 Web 開發中的所有快捷方式和工具

前言

由於個人一直喜歡使用 markdown 來寫 個人部落格,最近就整理了一下有哪些部落格引擎。

感興趣的小夥伴也可以選擇自己合適的。

pelican

Pelican 是一個靜態網站生成器,用Python編寫,它允許您透過編寫Markdown、reStructuredText和HTML等格式的文字檔案來建立網站。

使用Pelican,您可以建立網站而無需擔心資料庫或伺服器端程式設計。Pelican生成可以透過任何網路伺服器或託管服務提供的靜態站點。

您可以使用Pelican執行以下功能:

  • 使用您選擇的編輯器在Markdown或reStructuredText中編寫內容

  • 簡單的命令列工具重新生成HTML、CSS和JS源內容

  • 易於與版本控制系統和Web掛鉤進行介面

  • 完全靜態的輸出可以簡單地託管在任何地方

功能特點

Pelican的功能亮點包括:

  • 時間排序的內容(例如,文章、部落格文章)以及靜態頁面

  • 與外部服務的整合

  • 站點主題(使用Jinja2模板建立)

  • 在多種語言中釋出文章

  • 生成Atom和RSS訂閱源

  • 透過Pygments進行程式碼語法高亮顯示

  • 從WordPress、Dotclear或RSS訂閱源匯入現有內容

  • 由於內容快取和選擇性輸出編寫,重建速度快

  • 可透過豐富的外掛生態系統進行擴充套件:Pelican外掛

檢視 Pelican 文件 以獲取更多資訊。

為什麼叫“Pelican”?

“Pelican”是“calepin”的一個變位詞,法語中意為“筆記本”。

Pelican主題

該儲存庫包含了用於Pelican的主題。請隨意克隆、新增您自己的主題,並提交拉取請求。這是由社群管理的!

您可以在 http://www.pelicanthemes.com 檢視實時版本。

使用主題

以下說明假定您已經閱讀了所有Pelican文件,有一個工作站點,並且現在想要應用一個非預設主題。

首先,選擇一個位置來存放您的主題。對於這個示例,我們將使用目錄~/pelican-themes,但您的目錄可能不同。

在您的本地機器上將pelican-themes儲存庫克隆到該位置:

git clone --recursive https://github.com/getpelican/pelican-themes ~/pelican-themes

現在您應該在 ~/pelican-themes/ 下儲存您的 pelican-themes 儲存庫。

要使用其中一個主題,請編輯您的Pelican設定檔案以包含以下行:

THEME = "/home/user/pelican-themes/theme-name"

所以,例如,要使用mnmlist主題,您將編輯您的設定檔案以包含:

THEME = "/home/user/pelican-themes/mnmlist"

儲存對設定檔案的更改,然後使用您已經設定的 pelican-quickstart Makefile 重新生成您的站點:

make html

也可以透過-pelican命令的 -t ~/pelican-themes/theme-name 引數直接指定主題。

如果您想要編輯您的主題,請確保您所做的任何編輯都是針對儲存在~/pelican-themes/theme-name中的副本進行的。

對於儲存在站點輸出目錄中的檔案所做的任何更改都將在下次生成站點時被刪除。

Pelican外掛
重要提示:我們正在將外掛從這個單一的儲存庫遷移到它們自己的獨立儲存庫,這些儲存庫位於新的Pelican外掛組織下,這是一個供外掛作者與Pelican維護者和社群其他成員更廣泛合作的地方。我們的意圖是讓所有新組織下的外掛都採用新的“名稱空間外掛”格式,這意味著這些外掛可以輕鬆地透過Pip安裝,並且Pelican 4.5+可以立即識別它們——而不必顯式啟用它們。

這個過渡過程需要一些時間,因此我們感謝您在此期間的耐心等待。如果您想幫助加速這個過渡,以下內容將非常有幫助:

  • 如果您在這裡找到一個尚未遷移到新組織的外掛,請在這個儲存庫下建立一個新的問題,並說明您想要幫助遷移的外掛,之後Pelican維護者將指導您完成此過程。
  • 如果您來到這裡提交一個拉取請求以新增您的外掛,請考慮將您的外掛移動到Pelican外掛組織下。要開始,請在這個儲存庫下建立一個新的問題,提供您外掛的詳細資訊,之後Pelican維護者將指導您完成此過程。
  • 無論您是建立新外掛還是遷移現有外掛,請使用提供的Cookiecutter模板生成符合社群約定的腳手架名稱空間外掛。檢視Simple Footnotes儲存庫,以檢視一個已遷移外掛的示例。

以下其餘資訊與傳統外掛相關,但不適用於Pelican外掛組織中的新名稱空間外掛。

如何使用外掛

安裝和使用這些外掛的最簡單方法是克隆這個儲存庫:

git clone --recursive https://github.com/getpelican/pelican-plugins

並在您的設定檔案中啟用您想要的外掛:

PLUGIN_PATHS = ['path/to/pelican-plugins']
PLUGINS = ['assets', 'sitemap', 'gravatar']

PLUGIN_PATHS可以是相對於您的設定檔案的路徑,也可以是絕對路徑。

或者,如果外掛位於可匯入的路徑中,您可以省略PLUGIN_PATHS並列出它們:

PLUGINS = ['assets', 'sitemap', 'gravatar']

或者您可以直接匯入外掛並給出:

import my_plugin
PLUGINS = [my_plugin, 'assets']

相關文章