page


Namepage JSON
Version 0.3 PyPI version JSON
download
home_pageNone
SummaryStatic website generator
upload_time2024-11-24 21:40:58
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseBSD License
keywords cms static
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Page, a static website generator
================================

![website = compile(markdown content, templates)](page.png)

- creates a well organized website with clear navigation
  reflecting the folder structure of source text documents
- fast, well compressed, mobile friendly pages
- feed and sitemap files for your subscribers and search engines
- import from any CMS DB (inc. Wordpress), import HTML sites

Writers love distraction free conventional plain text
[formatting](https://commonmark.org/help/).
Template designers love the easy to read, beautiful and powerful
[template language](https://palletsprojects.com/p/jinja/).

Installation and run
--------------------
Page is a small command line program written in Python programming language.
It requires [python installed](https://www.python.org/downloads/), which lets user
install Page on any platform in a single command.

    pip install page

By default, Page will collect all text files in current folder
and create a HTML website in a static folder using default templates. Run the program

    page

it will look for a config file
[`./page.yml`](https://github.com/fmalina/page/blob/main/page.yml)
with custom options.

    source: /markdown/source/folder/
    target: /target/folder/
    tpl: /custom/template/folder/
    ext: ''  # or '.htm'
    ctx:
        site_name: 'My Site'
        site_url: https://example.org


Batteries included
------------------
Minimal default template.

Page has lots of tests including one importing an existing HTML site,
converting it to source markdown files and then back into a static HTML site
in full circle. This code can inspire users to convert existing static site
or one powered by a slow Content Management System to simple
markdown powered static site and maintain it with Page.

Programmers using Djagno Web Framework can make their sites faster and less demanding
using **static cache generation** helpers provided,
see [static.py](https://github.com/fmalina/page/blob/main/static.py).

E-commerce features for static shops (cart, checkout, persistence) implemented as a 
[shop template](https://github.com/fmalina/pageshop)

Example websites using page with sources
----------------------------------------

* [Normy Jedal/Dish standards](https://unilexicon.com/nom) in Slovak language
        [[sources]](https://github.com/fmalina/revisions-nom)
* [Sip Sip — Herbal Medicine](https://unilexicon.com/sip) in Slovak language
        [[sources]](https://github.com/fmalina/revisions-sip)
* Blocl [activist literature](https://blocl.uk/activism),
        [blog](https://blocl.uk/blog),
        [privacy policy](https://blocl.uk/privacy)
        [[sources]](https://github.com/fmalina/revisions-blocl)

Note: public repositories for projects using page begin with word "revisions" to prevent them
from being indexed in public search engines as per [github.com/robots.txt](https://github.com/robots.txt)

---

Designed in Slovakia by [Francis Malina](https://unilexicon.com/fm/).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "page",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "CMS, static",
    "author": null,
    "author_email": "\"F. Malina\" <fmalina@pm.me>",
    "download_url": "https://files.pythonhosted.org/packages/a4/0f/368ef0f0083cbe8e169257fe5818660685fb0826c64750f9e61004e32bca/page-0.3.tar.gz",
    "platform": null,
    "description": "Page, a static website generator\n================================\n\n![website = compile(markdown content, templates)](page.png)\n\n- creates a well organized website with clear navigation\n  reflecting the folder structure of source text documents\n- fast, well compressed, mobile friendly pages\n- feed and sitemap files for your subscribers and search engines\n- import from any CMS DB (inc. Wordpress), import HTML sites\n\nWriters love distraction free conventional plain text\n[formatting](https://commonmark.org/help/).\nTemplate designers love the easy to read, beautiful and powerful\n[template language](https://palletsprojects.com/p/jinja/).\n\nInstallation and run\n--------------------\nPage is a small command line program written in Python programming language.\nIt requires [python installed](https://www.python.org/downloads/), which lets user\ninstall Page on any platform in a single command.\n\n    pip install page\n\nBy default, Page will collect all text files in current folder\nand create a HTML website in a static folder using default templates. Run the program\n\n    page\n\nit will look for a config file\n[`./page.yml`](https://github.com/fmalina/page/blob/main/page.yml)\nwith custom options.\n\n    source: /markdown/source/folder/\n    target: /target/folder/\n    tpl: /custom/template/folder/\n    ext: ''  # or '.htm'\n    ctx:\n        site_name: 'My Site'\n        site_url: https://example.org\n\n\nBatteries included\n------------------\nMinimal default template.\n\nPage has lots of tests including one importing an existing HTML site,\nconverting it to source markdown files and then back into a static HTML site\nin full circle. This code can inspire users to convert existing static site\nor one powered by a slow Content Management System to simple\nmarkdown powered static site and maintain it with Page.\n\nProgrammers using Djagno Web Framework can make their sites faster and less demanding\nusing **static cache generation** helpers provided,\nsee [static.py](https://github.com/fmalina/page/blob/main/static.py).\n\nE-commerce features for static shops (cart, checkout, persistence) implemented as a \n[shop template](https://github.com/fmalina/pageshop)\n\nExample websites using page with sources\n----------------------------------------\n\n* [Normy Jedal/Dish standards](https://unilexicon.com/nom) in Slovak language\n        [[sources]](https://github.com/fmalina/revisions-nom)\n* [Sip Sip \u2014 Herbal Medicine](https://unilexicon.com/sip) in Slovak language\n        [[sources]](https://github.com/fmalina/revisions-sip)\n* Blocl [activist literature](https://blocl.uk/activism),\n        [blog](https://blocl.uk/blog),\n        [privacy policy](https://blocl.uk/privacy)\n        [[sources]](https://github.com/fmalina/revisions-blocl)\n\nNote: public repositories for projects using page begin with word \"revisions\" to prevent them\nfrom being indexed in public search engines as per [github.com/robots.txt](https://github.com/robots.txt)\n\n---\n\nDesigned in Slovakia by [Francis Malina](https://unilexicon.com/fm/).\n",
    "bugtrack_url": null,
    "license": "BSD License",
    "summary": "Static website generator",
    "version": "0.3",
    "project_urls": {
        "Funding": "https://unilexicon.com/fm/pay.html"
    },
    "split_keywords": [
        "cms",
        " static"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "82c94c2c611bd011bcd16f10fe9c8ec6ad961d8d68bcc2a68d8b84bd5c89b961",
                "md5": "3c74a3024242f381372154a86dd8d549",
                "sha256": "7968fec3e8c8d99171f32cf716c669afa8462d53eaddf43afecb02046e27000d"
            },
            "downloads": -1,
            "filename": "page-0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3c74a3024242f381372154a86dd8d549",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 12472,
            "upload_time": "2024-11-24T21:40:56",
            "upload_time_iso_8601": "2024-11-24T21:40:56.808965Z",
            "url": "https://files.pythonhosted.org/packages/82/c9/4c2c611bd011bcd16f10fe9c8ec6ad961d8d68bcc2a68d8b84bd5c89b961/page-0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a40f368ef0f0083cbe8e169257fe5818660685fb0826c64750f9e61004e32bca",
                "md5": "269e7716303d84ed869bc62fb1d84aa6",
                "sha256": "a2510adcf3a4ed2af49e95bcf2a8faf6dd5a207537a2796f17e13714fa4f2d2a"
            },
            "downloads": -1,
            "filename": "page-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "269e7716303d84ed869bc62fb1d84aa6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 13133,
            "upload_time": "2024-11-24T21:40:58",
            "upload_time_iso_8601": "2024-11-24T21:40:58.651962Z",
            "url": "https://files.pythonhosted.org/packages/a4/0f/368ef0f0083cbe8e169257fe5818660685fb0826c64750f9e61004e32bca/page-0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-24 21:40:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "page"
}
        
Elapsed time: 0.61698s