Shulou(Shulou.com)06/02 Report--

Python static website generator Pelican how to use, many novices are not very clear about this, in order to help you solve this problem, the following editor will explain in detail for you, people with this need can come to learn, I hope you can gain something.

Pelican is a choice for Python users who want to host simple websites or blogs themselves.

If you want to create a custom website or blog, there are many options. Many providers can host your website and do most of the work for you. (WordPress is a very popular option. ) but by using hosting, you will lose some flexibility. As a software developer, I prefer to manage my own server and keep more freedom in how my website works.

However, managing the Web server requires a lot of work. It is very easy to install it and get a simple application to provide content. However, maintaining security patches and updates is very time-consuming. If you only want to provide static web pages, it may outweigh the gain to have a Web server and a range of applications. Creating HTML pages manually is not a good choice either.

This is an opportunity for static website builders to display their talents. These applications use templates to create the required static pages and cross-link them with the associated metadata. (for example, all displayed pages have public tags or keywords. Static site Builder can help you create a site with a public appearance using elements such as navigation areas, headers, and footers.

I've been using Pyhton for many years, so when I started looking for something to generate static HTML pages, I wanted something written in Python. The main reason is that I often want to know the internal details of how the application works, which is made easier by using a language I already know. (if this doesn't matter to you or you don't use Python, there are some other great static site builders that use Ruby, JavaScript, and other languages. )

I decided to try Pelican. It is a commonly used static website generator written in Python. It supports reStructuredText, which is a file format for text data and technical documentation for the Python community, as well as Markdown, which is done by installing the necessary packages. All tasks are performed through the command line interface (CLI) tool, which makes it easy for anyone familiar with the command line to do it. Its simple quickstart CLI tool makes it easy to create a website.

In this article, I'll show you how to install Pelican 4, add an article, and change the default theme. (note: I was developed on MacOS, and the results of other Unix/Linux experiments will be the same, but I don't have a Windows host to test. )

Installation and configuration

The step is to create a virtual environment and install Pelican in the virtual environment.

$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.23

Pelican's quickstart CLI tool will create a basic layout and some files to help you get started and run the pelican-quickstart command. For simplicity, I entered the title of the site and the name of the author, and selected "N" for the URL prefix and article paging. (for other options, I used the default value. It is very easy to change these settings later in the configuration file

$. / 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 (YPAPO) n > Do you want to enable article pagination? (YBO) n > What is your time zone? [Europe/Paris] > Do you want to generate a tasks.py/Makefile to automate generation and publishing? (YBO) > Do you want to upload your website using FTP? (y Do you want to upload your website using SSH N) >? (y Do you want to upload your website using Dropbox N) >? () > Do you want to upload your website using S3? (y Do you want to upload your website using Rackspace Cloud Files N) >? (y Do you want to upload your website using GitHub Pages N) >? (Ycompan N) Done. Your new project is available at / Users/craig/tmp/pelican/test-site

All the files you need to start are ready.

Quickstart defaults to the European / Paris time zone, so change it before continuing. Open the pelicanconf.py file in your favorite text editor and look for the TIMEZONE variable.

TIMEZONE = 'Europe/Paris'

Change it to UTC.

TIMEZONE = 'UTC'

To update the public settings, look for the SOCIAL variable in pelicanconf.py.

SOCIAL = ('You can add links in your config file',' #'), ('Another social link',' #'),)

I will add a link to my Twitter account.

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

Pay attention to the comma at the end, it is very important. This comma will help Python recognize that a variable is actually a collection. Make sure you don't delete the comma.

Now you have the basic knowledge of the website. Quickstart creates a Makefile that contains many targets. The pass devserver to make command will start a development server on your computer so that you can preview everything. The CLI command used in Makefile is assumed to be in the PATH search path, so you need to activate the virtual environment first.

$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.

Open http://localhost:8000 in your favorite browser to view your simple test blog.

You can see links to Twitter on the right and links to Pelican, Python and Jinja on the left. Jinja is a great templating language that Pelican can use. You can learn more about it in the Jinja documentation. )

Add content

Now that you have a basic website, try to add some content. First, add a file named welcome.rst to the content directory of the Web site. In your favorite text editor, create a file with the following text:

$pwd/Users/craig/tmp/pelican/test-site$ cat content/welcome.rst Welcome to my blogs #: date: 20181216 08:30:tags: welcome:category: Intro:slug: welcome:author: Craig:summary: Welcome document Welcome to my blog.This is a short page just to show how to put up a static page.

Pelican automatically parses metadata rows, including dates, labels, and so on.

After writing the file, the development server should output the following:

-> Modified: content. Regenerating...Done: Processed 1 article, 0 drafts, 0 pages, 0 hidden pages and 0 draft pages in 0.10 seconds.

Refresh your test site in the browser to see the changes.

Metadata, such as dates and tags, is automatically added to the page. In addition, Pelican automatically detects the intro column and adds that section to the top navigation.

Change theme

One of the benefits of using popular open source software like Pelican is that a very large number of users will make changes and contribute them to the project. Many of them are contributed in the form of themes.

The theme of the site will set color, layout options, and so on. It's easy to try a new theme, and you can preview a lot of it in the Pelican theme.

First, clone the GitHub repository:

$cd.. $git clone-- recursive https://github.com/getpelican/pelicanthemesCloning into 'pelicanthemes'...

I like blue, so try blueidea.

Edit the pelicanconf.py and add the following line:

THEME ='/ Users/craig/tmp/pelican/pelican-themes/blueidea/'

The development server will regenerate your output. Refresh the page in the browser to see the new theme.

Themes control all aspects of the layout. For example, in the default theme, you can see the Intro next to the article (meta tag), but this column does not appear in the blueidea theme.

Other considerations

This article is a quick introduction to Pelican, so I didn't cover any important topics.

First of all, one of the reasons I'm hesitant to move to a static site is that it can't comment on the article. Fortunately, there are some third-party service providers that will provide you with the comment function. What I'm looking at right now is Disqus.

Next, all of the above is done on my local machine. If I want someone else to view my site, I will have to upload the pre-generated HTML file somewhere. If you look at the pelican-quickstart output, you will see options for using FTP, SSH, S3, or even GitHub pages, each with its advantages and disadvantages. However, if I had to choose one, I might choose to publish to the GitHub page.

Pelican has many other features, and I learn it every day. If you want to host a website or blog with simple and static content, and you want to use Python, then Pelican is a good choice. It has an active user community that fixes bug, adds features, and creates new and interesting topics. Give it a try!

Is it helpful for you to read the above content? If you want to know more about the relevant knowledge or read more related articles, please follow the industry information channel, thank you for your support.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.