Name | page JSON |
Version |
0.2.1
JSON |
| download |
home_page | None |
Summary | Static website generator |
upload_time | 2024-11-18 19:51:43 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.9 |
license | BSD 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/page/blob/main/page/templates/shop/README.md)
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/be/45/18da6ddc2bf92b4ee4f19a6fbcc984c28b19330288f8fa1a0bf0689e37f9/page-0.2.1.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/page/blob/main/page/templates/shop/README.md)\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.2.1",
"project_urls": {
"Funding": "https://unilexicon.com/fm/pay.html"
},
"split_keywords": [
"cms",
" static"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "113ab2fb35c5fe2d983b473176530d9b4414e6b7e65bc19ef5d340dd3909970e",
"md5": "92dc658a4f362e7df539f066179b64a1",
"sha256": "69b055f365c8926c6185b061d9cec173933101ca29fc2a68336f9afd32d57b02"
},
"downloads": -1,
"filename": "page-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92dc658a4f362e7df539f066179b64a1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 22416,
"upload_time": "2024-11-18T19:51:41",
"upload_time_iso_8601": "2024-11-18T19:51:41.942133Z",
"url": "https://files.pythonhosted.org/packages/11/3a/b2fb35c5fe2d983b473176530d9b4414e6b7e65bc19ef5d340dd3909970e/page-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "be4518da6ddc2bf92b4ee4f19a6fbcc984c28b19330288f8fa1a0bf0689e37f9",
"md5": "380a2f9b5a2a9512e887bc8a7db059f0",
"sha256": "458fd3a9b5395232544d9814aa8cd4c519ef11d58f6699a194b88d191f86d8f8"
},
"downloads": -1,
"filename": "page-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "380a2f9b5a2a9512e887bc8a7db059f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 19276,
"upload_time": "2024-11-18T19:51:43",
"upload_time_iso_8601": "2024-11-18T19:51:43.783844Z",
"url": "https://files.pythonhosted.org/packages/be/45/18da6ddc2bf92b4ee4f19a6fbcc984c28b19330288f8fa1a0bf0689e37f9/page-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 19:51:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "page"
}