Pelican 入門：一個 Python 靜態(tài)網(wǎng)站生成器

時間：2023-07-21 11:21:01 | 來源：網(wǎng)站運營

時間：2023-07-21 11:21:01 來源：網(wǎng)站運營

Pelican 入門：一個 Python 靜態(tài)網(wǎng)站生成器：

Pelican 是那些想要自我托管簡單網(wǎng)站或博客的 Python 用戶的絕佳選擇。

如果你想創(chuàng)建一個自定義網(wǎng)站或博客，有很多選擇。許多提供商可以托管你的網(wǎng)站并為你完成大部分工作。（WordPress 是一個非常受歡迎的選項。）但是使用托管方式，你會失去一些靈活性。作為一名軟件開發(fā)人員，我更喜歡管理我自己的服務(wù)器，并在我的網(wǎng)站如何運行方面保持更多的自由。

然而，管理 Web 服務(wù)器需要大量的工作。安裝它并獲得一個簡單的應(yīng)用程序來提供內(nèi)容是非常容易的。但是，維護(hù)安全補丁和更新是非常耗時得。如果你只想提供靜態(tài)網(wǎng)頁，那么擁有一個 Web 服務(wù)器和一系列應(yīng)用程序可能會得不償失。手動創(chuàng)建 HTML 頁面也不是一個好選擇。

這是靜態(tài)網(wǎng)站生成器的用武之地。這些應(yīng)用程序使用模板來創(chuàng)建所需的靜態(tài)頁面，并將它們與關(guān)聯(lián)的元數(shù)據(jù)交叉鏈接。（例如，所有顯示的頁面都帶有公共標(biāo)簽或關(guān)鍵詞。）靜態(tài)網(wǎng)站生成器可以幫助你使用導(dǎo)航區(qū)域、頁眉和頁腳等元素創(chuàng)建一個具有公共外觀的網(wǎng)站。

我使用 Pyhton 已經(jīng)很多年了，所以，當(dāng)我第一次開始尋找生成靜態(tài) HTML 頁面的東西時，我想要用 Python 編寫的東西。主要原因是我經(jīng)常想要了解應(yīng)用程序如何工作的內(nèi)部細(xì)節(jié)，而使用一種我已經(jīng)了解的語言使這一點更容易。（如果這對你不重要或者你不使用 Python，那么還有一些其他很棒的靜態(tài)網(wǎng)站生成器，它們使用 Ruby、JavaScript 和其它語言。）

我決定試試 Pelican。它是一個用 Python 編寫的常用靜態(tài)網(wǎng)站生成器。它支持 reStructuredText（LCTT 譯注：這是一種用于文本數(shù)據(jù)的文件格式，主要用于 Python 社區(qū)的技術(shù)文檔），并且也支持 Markdown，這需要通過安裝必需的包來完成。所有任務(wù)都是通過命令行界面（CLI）工具執(zhí)行的，這使得熟悉命令行的任何人都可以輕松完成。它簡單的 quickstart CLI 工具使得創(chuàng)建一個網(wǎng)站非常容易。

在本文中，我將介紹如何安裝 Pelican 4，添加一篇文章以及更改默認(rèn)主題。（注意：我是在 MacOS 上開發(fā)的，使用其它 Unix/Linux 實驗結(jié)果都將相同，但我沒有 Windows 主機可以測試。）

安裝和配置

第一步是創(chuàng)建一個虛擬環(huán)境，在虛擬環(huán)境中安裝 Pelican。

$ mkdir test-site$ cd test-site$ python3 -m venv venv$ ./venv/bin/pip install --upgrade pip...Successfully installed pip-18.1$ ./venv/bin/pip install pelicanCollecting pelican...Successfully installed MarkupSafe-1.1.0 blinker-1.4 docutils-0.14 feedgenerator-1.9 jinja2-2.10 pelican-4.0.1 pygments-2.3.1 python-dateutil-2.7.5 pytz-2018.7 six-1.12.0 unidecode-1.0.23Pelican 的 quickstart CLI 工具將創(chuàng)建基本布局和一些文件來幫助你開始，運行 pelican-quickstart命令。為了簡單起見，我輸入了網(wǎng)站標(biāo)題和作者的名字，并對 URL 前綴和文章分頁選擇了 “N”。（對于其它選項，我使用了默認(rèn)值。）稍后在配置文件中更改這些設(shè)置非常容易。

$ ./venv/bin/pelicanquickstartWelcome to pelicanquickstart v4.0.1.This script will help you create a new Pelican-based website.Please answer the following questions so this script can generate the files needed by Pelican.> Where do you want to create your new web site? [.]> What will be the title of this web site? My Test Blog> Who will be the author of this web site? Craig> What will be the default language of this web site? [en]> Do you want to specify a URL prefix? e.g., https://example.com (Y/n) n> Do you want to enable article pagination? (Y/n) n> What is your time zone? [Europe/Paris]> Do you want to generate a tasks.py/Makefile to automate generation and publishing? (Y/n)> Do you want to upload your website using FTP? (y/N)> Do you want to upload your website using SSH? (y/N)> Do you want to upload your website using Dropbox? (y/N)> Do you want to upload your website using S3? (y/N)> Do you want to upload your website using Rackspace Cloud Files? (y/N)> Do you want to upload your website using GitHub Pages? (y/N)Done. Your new project is available at /Users/craig/tmp/pelican/test-site你需要啟動的所有文件都準(zhǔn)備好了。

quickstart 默認(rèn)為歐洲/巴黎時區(qū)，所以在繼續(xù)之前更改一下。在你喜歡的文本編輯器中打開 pelicanconf.py 文件，尋找 TIMEZONE 變量。

TIMEZONE = 'Europe/Paris'將其改為 UTC。

TIMEZONE = 'UTC'要更新公共設(shè)置，在 pelicanconf.py 中查找 SOCIAL 變量。

SOCIAL = (('You can add links in your config file', '#'), ('Another social link', '#'),)我將添加一個我的 Twitter 賬戶鏈接。

SOCIAL = (('Twitter (#craigs55)', 'https://twitter.com/craigs55'),)注意末尾的逗號，它很重要。這個逗號將幫助 Python 識別變量實際上是一個集合。確保你沒有刪除這個逗號。

現(xiàn)在你已經(jīng)有了網(wǎng)站的基本知識。quickstart 創(chuàng)建了一個包含許多目標(biāo)的 Makefile。將 devserver 傳給 make 命令將在你的計算機上啟動一個開發(fā)服務(wù)器，以便你可以預(yù)覽所有內(nèi)容。Makefile 中使用的 CLI 命令假定放在 PATH 搜索路徑中，因此你需要首先激活該虛擬環(huán)境。

$ source ./venv/bin/activate$ make devserverpelican -lr /Users/craig/tmp/pelican/test-site/content o/Users/craig/tmp/pelican/test-site/output -s /Users/craig/tmp/pelican/test-site/pelicanconf.py-> Modified: theme, settings. regenerating...WARNING: No valid files found in content for the active readers: | BaseReader (static) | HTMLReader (htm, html) | RstReader (rst)Done: Processed 0 articles, 0 drafts, 0 pages, 0 hidden pages and 0 draft pages in 0.18 seconds.在你最喜歡的瀏覽器中打開 http://localhost:8000 來查看你的簡單測試博客。







你可以在右側(cè)看到 Twitter 鏈接，左側(cè)有 Pelican、Python 和 Jinja 的一些鏈接。（Jinja 是 Pelican 可以使用的一種很棒的模板語言。你可以在 Jinja 的文檔中了解更多相關(guān)信息。）

添加內(nèi)容

現(xiàn)在你又了一個基本的網(wǎng)站，試著添加一些內(nèi)容。首先，將名為 welcome.rst 的文件添加到網(wǎng)站的 content 目錄中。在你喜歡的文本編輯器中，使用以下文本創(chuàng)建一個文件：

$ pwd/Users/craig/tmp/pelican/test-site$ cat content/welcome.rstWelcome to my blog!###################:date: 20181216 08:30:tags: welcome:category: Intro:slug: welcome:author: Craig:summary: Welcome documentWelcome to my blog.This is a short page just to show how to put up a static page.Pelican 會自動解析元數(shù)據(jù)行，包括日期、標(biāo)簽等。

編寫完文件后，開發(fā)服務(wù)器應(yīng)該輸出以下內(nèi)容：

-> Modified: content. regenerating...Done: Processed 1 article, 0 drafts, 0 pages, 0 hidden pages and 0 draft pages in 0.10 seconds.在瀏覽器中刷新你的測試網(wǎng)站來查看更改。







元數(shù)據(jù)（例如日期和標(biāo)簽）會自動添加到頁面中。此外，Pelican 會自動檢測到 intro 欄目，并將該部分添加到頂部導(dǎo)航中。

更改主題

使用像 Pelican 這樣流行的開源軟件的好處之一是，非常多的用戶會做出更改并將其貢獻(xiàn)給項目。許多都是以主題形式貢獻(xiàn)的。

網(wǎng)站的主題會設(shè)置顏色、布局選項等。嘗試一個新主題非常容易，你可以在 Pelican 主題中預(yù)覽其中的許多內(nèi)容。

首先，克隆 GitHub 倉庫:

$ cd ..$ git clone --recursive https://github.com/getpelican/pelicanthemesCloning into 'pelicanthemes'...我喜歡藍(lán)色，那么試試 blueidea。

編輯 pelicanconf.py，添加以下行：

THEME = '/Users/craig/tmp/pelican/pelican-themes/blueidea/'開發(fā)服務(wù)器將重新生成你的輸出。在瀏覽器中刷新網(wǎng)頁來查看新主題。







主題控制布局的方方面面。例如，在默認(rèn)主題中，你可以看到文章旁邊帶有元標(biāo)記的欄目（Intro），但這個欄目并未顯示在 blueidea 主題中。

其他考慮因素

本文是對 Pelican 的快速介紹，所以我并沒有涉及一些重要的主題。

首先，我對遷移到靜態(tài)站點猶豫不決的一個原因是它無法對文章評論。幸運的是，有一些第三方服務(wù)商將為你提供評論功能。我目前正在關(guān)注的是 Disqus。

接下來，上面的所有內(nèi)容都是在我的本地機器上完成的。如果我希望其他人查看我的網(wǎng)站，我將不得不將預(yù)先生成的 HTML 文件上傳到某個地方。如果你查看 pelican-quickstart 輸出，你將看到使用 FTP、 SSH、S3 甚至 GitHub 頁面的選項，每個選項都有其優(yōu)點和缺點。但是，如果我必須選擇一個，那么我可能會選擇發(fā)布到 GitHub 頁面。

Pelican 還有許多其他功能，我每天都在學(xué)習(xí)它。如果你想自托管一個網(wǎng)站或博客，內(nèi)容簡單并且是靜態(tài)內(nèi)容，同時你想使用 Python，那么 Pelican 是一個很好的選擇。它有一個活躍的用戶社區(qū)，可以修復(fù) bug，添加特性，而且還會創(chuàng)建新的和有趣的主題。試試看吧！

---

via: https://opensource.com/article/19/1/getting-started-pelican

作者：Craig Sebenik 選題：lujun9972 譯者：MjSeven 校對：wxy

本文由 LCTT 原創(chuàng)編譯，Linux中國 榮譽推出