Pelican, een op Python gebaseerde statische sitegenerator

over Pelikaan

In het volgende artikel gaan we Pelican bekijken. Dit is een goede optie voor Python-gebruikers die zelf een eenvoudige website of blog willen hosten. Als u geïnteresseerd bent in het maken van een aangepaste website of blog, heeft u tegenwoordig veel opties. Maar als alleen u statische webpagina's wilt aanbieden, kan deze statische sitebuilder nuttig voor u zijn. Dit soort toepassingen gebruiken sjablonen om alle statische pagina's te maken die de gebruiker wil, en deze te koppelen aan de bijbehorende metadata.

Als je gebruikt Python en je bent op zoek naar iets om statische HTML-pagina's te genereren, zal deze generator je in staat stellen om de binnenkant te bekijken van hoe het werkt. Het gebruik van een taal die u kent, maakt het gemakkelijker. Als je Python niet leuk vindt, zijn er andere statische sitegeneratoren die andere talen gebruiken.

Pelican is een veelgebruikte statische sitegenerator geschreven in Python. Oosten ondersteunt direct reStructuredText en kan Markdown ondersteunen, wanneer het vereiste pakket is geïnstalleerd. Alle taken worden uitgevoerd via opdrachtregelinterfacetools (CLI), wat het eenvoudig maakt voor iedereen die ermee bekend is. Bovendien maakt de eenvoudige snelstarttool het maken van een website uiterst eenvoudig.

Pelican-installatie en basisconfiguratie

Ik test dit programma op Ubuntu 20.04. De eerste stap die moet worden gevolgd, is: maak een virtualenv en installeer Pelican. Dit kan gedaan worden door een terminal te openen (Ctrl + Alt + T) en de commando's erin te gebruiken:

creatie van de virtuele omgeving

mkdir test-sitio

cd test-sitio

python3.8 -m venv venv

./venv/bin/pip install --upgrade pip

Na het updaten van pip, kunnen we nu installeer Pelican:

Pelikaan faciliteit

./venv/bin/pip install pelican

Voer de opdracht pelikaan-snelstart uit

Eenmaal geïnstalleerd, de Pelican Quick Start CLI-tool maakt de basislay-out en enkele bestanden zodat we aan de slag kunnen.

Om het simpel te houden, heb ik bij het uitvoeren van de snelle start de waarden voor de titel en auteur gebruikt en geantwoord N naar het url-voorvoegsel en de paginering van het artikel. Voor de rest van de vragen, ik heb de standaard gebruikt. Het is heel eenvoudig om deze instellingen later in het configuratiebestand te wijzigen. Snelle start kan worden uitgevoerd met het commando:

snelstart pelikaan

./venv/bin/pelican-quickstart

Als het klaar is, kunnen we bepaalde aspecten van de instellingen wijzigen. We moeten gewoon open het pelicanconf.py-bestand in onze favoriete teksteditor.

configuratiebestand

Binnen kunnen we zoeken naar de regel:

TIMEZONE = 'Europe/Paris'

En we kunnen verander naar de tijdzone van het land dat u interesseert.

naar update sociale link instellingen, je moet zoeken naar de variabele SOCIAAL en pelicanconf.py. Daarin kunnen we onze links als volgt toevoegen:

SOCIAL = (('Twitter (#Ubunlog)', 'https://twitter.com/UbunlogWeb'),)

Houd er rekening mee dat de komma aan het einde belangrijk is. Die komma helpt Python te herkennen dat de variabele eigenlijk een set is. Zorg ervoor dat u het niet verwijdert.

Start de server

Nu we de basis van een site hebben, kunnen we zien dat de quickstart een Makefile heeft gemaakt met verschillende doelen. Een van hen maakt devserver kan een ontwikkelingsserver op onze machine starten zodat we een voorbeeld kunnen zien van alles wat we maken. De CLI-commando's die in de Makefile worden gebruikt, worden verondersteld deel uit te maken van ons PATH, dus eerst we moeten virtualenv activeren.

server starten

source ./venv/bin/activate

make devserver

Als het begint, kunnen we open onze browser en ga naar de URL http://localhost:8000 om de blog te zien die is aangemaakt.

voorbeeldpagina gemaakt met Pelican

Content toevoegen

Nu we een basissite hebben, kunnen we wat inhoud toevoegen. Eerst, we zullen een bestand aanmaken met de naam welkom.rst in de inhoudsmap (content) van de site.

Met onze favoriete teksteditor, we zullen dit bestand maken met een tekst die de volgende structuur volgt::

inhoud toevoegen in pelikaan

Bienvenid@ a este blog

######################

:date: 20210827 00:03

:tags: bienvenid@

:category: Intro

:slug: bienvenida

:author: ubunlog

:summary: Documento bienvenida

Bienvenid@ a este blog de prueba con Pelican.

Esta es una pequeña página se va a mostrar como página estática.
Pelican analiza automáticamente las líneas de metadatos (fecha, etiquetas, etc.).

Na het schrijven van het bestand, de devserver zou moeten updaten en zoiets als dit genereren:

welkomstbestand toegevoegd

Laad uw testsite opnieuw in de browser om de wijzigingen te zien.

statische welkomstpagina

De metadata is automatisch toegevoegd aan de pagina. Bovendien, Pelican heeft automatisch de categorie Intro gedetecteerd en de sectie toegevoegd aan de navigatie bovenaan.

Verander het onderwerp

Naast al het bovenstaande kunnen we gemakkelijk van onderwerp veranderen. In de repository Pelikaan-thema's, kunt u verschillende thema's vinden die gebruikers hebben gemaakt. Het is heel gemakkelijk om nieuwe thema's te testen, je hoeft ze alleen maar te downloaden uit de repository, sla ze op onze computer op en voeg in het bestand pelicanconf.py de volgende regel toe met het pad naar het thema:

THEME = "/home/tu-usuario/pelican-tema/nombre-del-tema"

De devserver zal de uitvoer opnieuw genereren. Laad de webpagina opnieuw in de browser om het nieuwe thema te zien.

Dit was een korte introductie tot Pelican. Dit alles gebeurde op een lokale machine. Als u wilt dat anderen uw site zien, moet u de vooraf gegenereerde HTML-bestanden uploaden naar een server. Als je in detail kijkt naar de output van pelikaan-snelstart, ziet u opties om FTP, SSH, S3 en zelfs de GitHub-pagina's te gebruiken.

Het kan meer informatie over deze generator in de project website of in jouw GitHub-opslagplaats.


Laat je reactie achter

Uw e-mailadres wordt niet gepubliceerd. Verplichte velden zijn gemarkeerd met *

*

*

  1. Verantwoordelijk voor de gegevens: Miguel Ángel Gatón
  2. Doel van de gegevens: Controle SPAM, commentaarbeheer.
  3. Legitimatie: uw toestemming
  4. Mededeling van de gegevens: De gegevens worden niet aan derden meegedeeld, behalve op grond van wettelijke verplichting.
  5. Gegevensopslag: database gehost door Occentus Networks (EU)
  6. Rechten: u kunt uw gegevens op elk moment beperken, herstellen en verwijderen.