Skip to main content

Yet another static blog generator.

Project description

pidgeotto

Description

Yet another static website generator.

Why choose pidgeotto?

  1. Free of javascript.
  2. Extensible, flexible, forkable.
  3. Minimal and fast.
  4. Free under GPLv3 License.

Installation

$ pip install git+https://github.com/niharokz/pidgeotto

Prerequisites

By default, pidgeotto will install the below packages from PyPI pip pyyaml, jinja2, markdown2

  • PyYAML: To consume the config file and header of blog posts.
  • jinja2: Templating engine
  • markdown2: To convert markdown to HTML

Usage:

$ pidgey init project

To initiate pidgeotto with name "project"

$ pidgey new pageName

To create new page/post/note with name "pageName"

$ pidgey build pageName

To build static pages and keep those in the "public" directory.

Extra Functionalaties

  1. showInHome tag is present in each note markdown. showInHome: True will create page which are blog/note post.

     ``` showInHome: False ``` 
     will create page which are pages.
    
  2. config.yml is extensible. For example, if you want to add favicon.ico. Keep favicon in the resource folder. favicon: resource/favicon.ico in config.yml In template, add {{ config.get('favicon') }}.

  3. Extra metadata per page. If you want to add some metadata to your page, it can be done using the below command on the markdown page. meta : '<link rel="stylesheet" type="text/css" href="/extra.css" />

Structure

pidgeotto_project
├── public
├── config.yml
├── content
│   ├── header.md
│   ├── footer.md
│   ├── home.md
│   ├── archive.md
│   └── note
│       └── other_pages.md
├── resource
└── templates
    ├── home_template.html
    ├── note_template.html
    └── rss_template.xml
  • config.yml: To configure the title, name, CSS file, js file, and other configurations.
  • resource: Location to store all CSS, js, image data and other static content.
  • content: All markdown files are stored here.
  • template: Layouts for different HTML pages are kept here.
  • public: All generated static files. It can be changed in config.yml

Example

Below are examples of sites running via pidgeotto.

  1. nihar.page

TODO

(A) 21-04-2021 Fix rss template (A) 21-04-2021 Add Serve functionality (B) 21-04-2021 Clean up some clutter coding

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pidgeotto-0.0.2.tar.gz (19.7 kB view details)

Uploaded Source

Built Distribution

pidgeotto-0.0.2-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file pidgeotto-0.0.2.tar.gz.

File metadata

  • Download URL: pidgeotto-0.0.2.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.3

File hashes

Hashes for pidgeotto-0.0.2.tar.gz
Algorithm Hash digest
SHA256 15f9d507acb045f13fa28193c19b9c902c4b49cd30c79216128f64ef7c886c3c
MD5 690e573e56d898e352f1a753b28948bf
BLAKE2b-256 5ac041b01ac1b030ac7404da12e05dbc2e20ed707efea8258f9446743b1006c9

See more details on using hashes here.

File details

Details for the file pidgeotto-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pidgeotto-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.3

File hashes

Hashes for pidgeotto-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 6f5ff25bb97369b5be204a52056a99ff2160640907cd71e07539c33caacb7155
MD5 113f7856465ae0733619af411edacb00
BLAKE2b-256 72cd23ff8d5428d97462045c59a0ec1f8c7562e659ad03aee4757d2aba791c56

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page