Skip to main content

Pelican

Pelican is a simple weblog generator, writen in python.

  • Write your weblog entries directly with your editor of choice (vim!) and directly in restructured text.

  • A simple cli-tool to (re)generate the weblog.

  • Easy to interface with DVCSes and web hooks

  • Completely static output, so easy to host anywhere !

Files metadatas

Pelican tries to be smart enough to get the informations he needs from the filesystem (for instance, about the category of your articles), but you need to provide by hand some of those informations in your files.

You could provide the metadata in the restructured text files, using the following syntax:

My super title
##############

:date: 2010-10-03 10:20
:tags: thats, awesome
:category: yeah
:author: Alexis Metaireau

Note that only the date metadata is mandatory, so you just have to add that in i your files. The category can also be determined by the directory where the rst file is. For instance, the category of python/foobar/myfoobar.rst is foobar.

Getting started — Generate your blog

Yeah? You’re ready? Let’s go ! You can install pelican in a lot of different ways, the simpler one is via pip:

$ pip install pelican

Then, you have just to launch pelican, like this:

$ pelican /path/to/your/content/

And… that’s all! You can see your weblog generated on the content/ folder.

This one will just generate a simple output, with the default theme. It’s not really sexy, as it’s a simple HTML output (without any style).

You can create your own style if you want, have a look to the help to see all the options you can use:

$ pelican --help

Why the name “Pelican” ?

Heh, you didnt noticed? “Pelican” is an anagram for “Calepin” ;)

Source code

You can access the source code via mercurial at http://hg.notmyidea.org/pelican/ or via git on http://github.com/ametaireau/pelican/

Feedback !

If you want to see new features in Pelican, dont hesitate to tell me, to clone the repository, etc. That’s open source, dude!

Contact me at “alexis at notmyidea dot org” for any request/feedback !

Metadata

Release files for pelican 2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pelican 2.3
File Size Uploaded
pelican-2.3.tar.gz 20.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pelican 2.3
File Interpreter ABI Platform
pelican-2.3-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 79.0 kB

Release files / pelican-2.3.tar.gz

Download URL pelican-2.3.tar.gz
Size 20.4 kB
Tags Source
SHA-256 checksum
How to use checksums
807e273ac3380374dc9d3e68703753018bd504abf6edc1653f7d5ee5d530d8bb
BLAKE2b-256 checksum
How to use checksums
251fcc6b937d72f2619c648216fc3e43d7ad756f607e554f458642781a97a0e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / pelican-2.3-py2.py3-none-any.whl

Download URL pelican-2.3-py2.py3-none-any.whl
Size 58.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
2c4c8f880cc1f53591827a693b146fef86a81181ceac832254722aed175bb367
BLAKE2b-256 checksum
How to use checksums
3f7c82d6d33cbe5fb43dee38abebbb1ac7fe10fdbd017a910bde81ac8875e22c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

4.12.0

2 release files

4.11.0

2 release files

4.10.2

2 release files

4.10.1

2 release files

4.10.0

2 release files

4.9.1

2 release files

4.9.0

2 release files

4.8.0

2 release files

4.7.2

2 release files

4.7.1

2 release files

4.7.0

2 release files

4.6.0

2 release files

4.5.4

2 release files

4.5.3

2 release files

4.5.2

2 release files

4.5.1

2 release files

4.5.0

2 release files

4.2.0

2 release files

4.1.3

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.1

2 release files

4.0.0

2 release files

3.7.1

2 release files

3.7.0

2 release files

3.6.3

2 release files

3.6.2

2 release files

3.6.0

2 release files

3.5.0

2 release files

3.4.0

1 release file

3.3

2 release files

3.2.2

2 release files

3.2.1

2 release files

3.2

2 release files

3.1.1

2 release files

3.1

2 release files

3.0.1

2 release files

3.0

2 release files

2.8.1

2 release files

2.8.0

2 release files

2.7.2

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.0

2 release files

2.5.3

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.5

2 release files

2.4.4

2 release files

2.4.3

2 release files

2.4.1

2 release files

2.4

2 release files

This release

2.3 This release

2 release files

2.1.1

2 release files

2.1

2 release files

2.0

2 release files

1.2.5

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2

1 release file

1.1.1

1 release file

1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page