| Name | braindead JSON |
| Version |
0.3.13
JSON |
| download |
| home_page | https://grski.pl/ |
| Summary | Braindead is a braindead simple static site generator for minimalists, that has support for markdown and code highlighting. |
| upload_time | 2023-10-17 01:49:31 |
| maintainer | |
| docs_url | None |
| author | Olaf Górski |
| requires_python | >=3.10,<4.0 |
| license | MIT |
| keywords |
ssg
static site generator
braindead
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Braindead
Braindead is a braindead simple static site generator for minimalists, that has support for markdown and code highlighting.
I created this package simply to have a bit of fun and because I'm tired of bloated software.
You can read more about the idea behind it on [medium](https://medium.com/thirty3hq/how-i-created-my-blogging-system-in-less-than-100-lines-of-code-to-save-the-environment-dd848cc29c02) or [my blog](https://grski.pl/posts/python/creating-braindead.html)
Can't we just have [simple software nowadays](https://tonsky.me/blog/disenchantment/) that does what it needs to do and nothing more?
Existing solutions felt like they are too much for my needs. So I built this thing. It's still under active development.
Live example: [grski.pl](https://grski.pl/)
One of my main ideals here is to create template that is as fast as it gets. Generated pages take around 10-15 KB in total.
No JavaScript used here, at least in the base template. Just css/html.
You are free to change that though by creating your own templates. More on that below.
Benefits of simple approach:
Default template scores 100/100 on Google PageSpeed Insights and has very fast load times.
Default template design looks like this:
It's based on: [Kiss template](https://github.com/ribice), slightly modified - with minimized styles. In the future I'll probably slim them down even more.
It's also eco friendly - it uses less power by not being a bloatware. [CarbonReport of the demo](https://www.websitecarbon.com/website/grski-pl/)
# Installation
```
pip install braindead
```
[PyPi page](https://pypi.org/project/braindead/)
# Usage
Create `index.md` and run `braindead run` that's it. You'll find your generated site in `dist` directory and the site being served at `localhost:1644`.
To get more context/help and available commands run `braindead` or `braindead help`.
Known commands so far: `run`, `build`, `serve`.
It can be empty or not - your choice. If you want index to contain just the posts - leave it empty.
That's the minimal setup you need. That'll generate index.html for you, but well, it's not enough, right?
More robust structure you can use is:
```bash
pages/
page.md
posts/
post.md
index.md
pyproject.toml
```
The url for generated html will be `{DIR_LOCATION}/{FILENAME}.html`,
so url generated will be `{config.base_url}/{DIR_LOCATION}/{FILENAME}.html` in order to change that, add
```markdown
Slug: custom-location
```
To your post/page header - then the location will be `{BASE_URL}/{SLUG}.html`
## Example post/page structure:
```markdown
Title: Title of the post or of the page
Date: 2018-03-22
Authors: Olaf Górski
Description: Description of the post/page. If not provided it'll default to first 140 chars of the content.
CONTENT GOES HERE...
```
All of the metadata used here will be available during given page rendering. You can add more keys and metadata if you'd like.
## Config
All of the variables that are used to generate the page can be overwritten by creating `pyproject.toml` file, but it's not required to get started.
Example of your `pyproject` `tool.braindead.site` section (these are also the defaults):
```toml
[tool.braindead.site]
base_url = "" # give full url ending with slash here - eg. if you host your blog on https://grski.pl/ enter it there.
author = "Olaf Górski" # author/owner of the site <- will be appended to the title
title = "Site generated with braindead" # base title of the website
description = "Just a description of site generated in braindead" # description used in the meta tags
content = "" # this will display under heading
name = "braindeadsite" # og tags
logo = "logo_url" # url to the logo for og tags
heading = "Braindead Example" # heading at the top of the site
github = "https://github.com/grski" # link to your github
linkedin = "https://linkedin.com/in/olafgorski" # link to your li
copy_text = "Olaf Górski" # copy text in the footer
copy_link = "https://grski.pl" # and copy link of the footer
language = "en" # default language set in the top level html lang property
just_titles = 0 # if set to 1 the index page will only display titles without descriptions on default template
```
None of these are required. You can overwrite none, one or more. Your choice.
# Code higlighting
Just do
<pre>
```python
Your code here
```</pre>
[List of languages supported by pygments can be found here.](https://pygments.org/languages/)
# Creating your own templates
TODO
# Technology
This bases on
[toml](https://github.com/uiri/toml),
[markdown](https://github.com/Python-Markdown/markdown) and [jinja2](https://github.com/pallets/jinja).
Toml is used for configuration.
Markdown to render all the .md and .markdows into proper html.
Lastly jinja2 to add some contexts here and there.
Formatting of the code is done using [black](https://github.com/psf/black), [isort](https://github.com/timothycrosley/isort).
[flake8](https://gitlab.com/pycqa/flake8), [autoflake](https://github.com/myint/autoflake) and [bandit](https://github.com/PyCQA/bandit/) to check for potential vulns.
Versioning is done with [bumpversion](https://github.com/peritus/bumpversion).
Patch for merges to develop, minor for merged to master. Merge to master means release to pypi.
And wonderful [poetry](https://github.com/python-poetry/poetry) as dependency manager. BTW pipenv should die.
Code highligthing is done with [pygments](https://github.com/pygments/pygments).
CLI is done with [cleo](https://github.com/sdispater/cleo)
I use type hinting where it's possible.
To start developing you need to install poetry
`pip install poetry==0.1.0` and then just `poetry install`.
# Known make commands
```bash
flake
isort
isort-inplace
bandit
black
linters
bumpversion
black-inplace
autoflake-inplace
format-inplace
```
Most important ones are `make linters` and `make format-inplace`. Before each commit it's required to run these checks.
# License
MIT
Raw data
{
"_id": null,
"home_page": "https://grski.pl/",
"name": "braindead",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "ssg,static site generator,braindead",
"author": "Olaf G\u00f3rski",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/db/2a/fa3a2ddb0425a986f6b6e5fd9a9949172485a12e8365941b3b66954b93d0/braindead-0.3.13.tar.gz",
"platform": null,
"description": "# Braindead\nBraindead is a braindead simple static site generator for minimalists, that has support for markdown and code highlighting.\nI created this package simply to have a bit of fun and because I'm tired of bloated software.\n\nYou can read more about the idea behind it on [medium](https://medium.com/thirty3hq/how-i-created-my-blogging-system-in-less-than-100-lines-of-code-to-save-the-environment-dd848cc29c02) or [my blog](https://grski.pl/posts/python/creating-braindead.html)\n\nCan't we just have [simple software nowadays](https://tonsky.me/blog/disenchantment/) that does what it needs to do and nothing more?\nExisting solutions felt like they are too much for my needs. So I built this thing. It's still under active development.\n\nLive example: [grski.pl](https://grski.pl/)\n\nOne of my main ideals here is to create template that is as fast as it gets. Generated pages take around 10-15 KB in total.\nNo JavaScript used here, at least in the base template. Just css/html.\n\nYou are free to change that though by creating your own templates. More on that below.\n\nBenefits of simple approach:\n\n\n\n \nDefault template scores 100/100 on Google PageSpeed Insights and has very fast load times.\n\nDefault template design looks like this:\n\n\nIt's based on: [Kiss template](https://github.com/ribice), slightly modified - with minimized styles. In the future I'll probably slim them down even more.\n\nIt's also eco friendly - it uses less power by not being a bloatware. [CarbonReport of the demo](https://www.websitecarbon.com/website/grski-pl/)\n\n# Installation\n```\npip install braindead\n```\n[PyPi page](https://pypi.org/project/braindead/)\n\n# Usage\nCreate `index.md` and run `braindead run` that's it. You'll find your generated site in `dist` directory and the site being served at `localhost:1644`.\nTo get more context/help and available commands run `braindead` or `braindead help`.\n\nKnown commands so far: `run`, `build`, `serve`.\n\nIt can be empty or not - your choice. If you want index to contain just the posts - leave it empty.\n\nThat's the minimal setup you need. That'll generate index.html for you, but well, it's not enough, right?\nMore robust structure you can use is:\n```bash\npages/\n page.md\nposts/\n post.md\nindex.md\npyproject.toml\n```\n\nThe url for generated html will be `{DIR_LOCATION}/{FILENAME}.html`,\n so url generated will be `{config.base_url}/{DIR_LOCATION}/{FILENAME}.html` in order to change that, add\n```markdown\nSlug: custom-location\n```\nTo your post/page header - then the location will be `{BASE_URL}/{SLUG}.html`\n\n## Example post/page structure:\n\n```markdown\nTitle: Title of the post or of the page \nDate: 2018-03-22\nAuthors: Olaf G\u00f3rski\nDescription: Description of the post/page. If not provided it'll default to first 140 chars of the content. \n\nCONTENT GOES HERE...\n```\n\nAll of the metadata used here will be available during given page rendering. You can add more keys and metadata if you'd like. \n\n## Config\n\nAll of the variables that are used to generate the page can be overwritten by creating `pyproject.toml` file, but it's not required to get started.\nExample of your `pyproject` `tool.braindead.site` section (these are also the defaults):\n\n```toml\n[tool.braindead.site]\nbase_url = \"\" # give full url ending with slash here - eg. if you host your blog on https://grski.pl/ enter it there.\nauthor = \"Olaf G\u00f3rski\" # author/owner of the site <- will be appended to the title\ntitle = \"Site generated with braindead\" # base title of the website\ndescription = \"Just a description of site generated in braindead\" # description used in the meta tags\ncontent = \"\" # this will display under heading\nname = \"braindeadsite\" # og tags\nlogo = \"logo_url\" # url to the logo for og tags\nheading = \"Braindead Example\" # heading at the top of the site\ngithub = \"https://github.com/grski\" # link to your github\nlinkedin = \"https://linkedin.com/in/olafgorski\" # link to your li\ncopy_text = \"Olaf G\u00f3rski\" # copy text in the footer\ncopy_link = \"https://grski.pl\" # and copy link of the footer\nlanguage = \"en\" # default language set in the top level html lang property\njust_titles = 0 # if set to 1 the index page will only display titles without descriptions on default template\n```\n\nNone of these are required. You can overwrite none, one or more. Your choice.\n\n# Code higlighting\nJust do\n<pre>\n```python\nYour code here\n```</pre>\n\n[List of languages supported by pygments can be found here.](https://pygments.org/languages/)\n\n# Creating your own templates\nTODO\n\n# Technology\nThis bases on \n[toml](https://github.com/uiri/toml), \n[markdown](https://github.com/Python-Markdown/markdown) and [jinja2](https://github.com/pallets/jinja).\n\nToml is used for configuration.\nMarkdown to render all the .md and .markdows into proper html.\nLastly jinja2 to add some contexts here and there.\n\nFormatting of the code is done using [black](https://github.com/psf/black), [isort](https://github.com/timothycrosley/isort).\n[flake8](https://gitlab.com/pycqa/flake8), [autoflake](https://github.com/myint/autoflake) and [bandit](https://github.com/PyCQA/bandit/) to check for potential vulns. \n\nVersioning is done with [bumpversion](https://github.com/peritus/bumpversion).\nPatch for merges to develop, minor for merged to master. Merge to master means release to pypi.\n\nAnd wonderful [poetry](https://github.com/python-poetry/poetry) as dependency manager. BTW pipenv should die.\n\nCode highligthing is done with [pygments](https://github.com/pygments/pygments).\n\nCLI is done with [cleo](https://github.com/sdispater/cleo)\n\nI use type hinting where it's possible.\n\nTo start developing you need to install poetry\n`pip install poetry==0.1.0` and then just `poetry install`. \n\n# Known make commands\n```bash\nflake\nisort\nisort-inplace\nbandit\nblack\nlinters\nbumpversion\nblack-inplace\nautoflake-inplace\nformat-inplace\n```\nMost important ones are `make linters` and `make format-inplace`. Before each commit it's required to run these checks.\n\n# License\nMIT\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Braindead is a braindead simple static site generator for minimalists, that has support for markdown and code highlighting.",
"version": "0.3.13",
"project_urls": {
"Documentation": "https://github.com/grski/braindead",
"Homepage": "https://grski.pl/",
"Repository": "https://github.com/grski/braindead"
},
"split_keywords": [
"ssg",
"static site generator",
"braindead"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f55de009420159bac1c91068f274a384319685acfc64a86a35da494ab3c16ae0",
"md5": "d98bc9a96a0bdb772e82fdbfe383bfce",
"sha256": "31bf52bee6e9c30fe3b522b631bed436bad52b3755e05ba5c4d4c2f2eb794a33"
},
"downloads": -1,
"filename": "braindead-0.3.13-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d98bc9a96a0bdb772e82fdbfe383bfce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 41516,
"upload_time": "2023-10-17T01:49:30",
"upload_time_iso_8601": "2023-10-17T01:49:30.124942Z",
"url": "https://files.pythonhosted.org/packages/f5/5d/e009420159bac1c91068f274a384319685acfc64a86a35da494ab3c16ae0/braindead-0.3.13-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db2afa3a2ddb0425a986f6b6e5fd9a9949172485a12e8365941b3b66954b93d0",
"md5": "dd3b97bbd3d709ccc268daa4e92e67cc",
"sha256": "8b90c748cc7126efdbb0ed1d702d2fd13f9cbb66e3981366481a520225b212ed"
},
"downloads": -1,
"filename": "braindead-0.3.13.tar.gz",
"has_sig": false,
"md5_digest": "dd3b97bbd3d709ccc268daa4e92e67cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 39449,
"upload_time": "2023-10-17T01:49:31",
"upload_time_iso_8601": "2023-10-17T01:49:31.722757Z",
"url": "https://files.pythonhosted.org/packages/db/2a/fa3a2ddb0425a986f6b6e5fd9a9949172485a12e8365941b3b66954b93d0/braindead-0.3.13.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-17 01:49:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "grski",
"github_project": "braindead",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "braindead"
}
