brigid


Namebrigid JSON
Version 0.5.0 PyPI version JSON
download
home_pagehttps://github.com/Tiendil/brigid
SummaryStatic site generator.
upload_time2024-03-24 15:56:10
maintainerNone
docs_urlNone
authorAliaksei Yaletski (Tiendil)
requires_python<4.0,>=3.12
licenseBSD-3-Clause
keywords blog blog-engine site markdown cms content management system personal site
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Brigid

A simple blog engine, but not simpler than it should be.

## Demo

- My blog: [tiendil.org](https://tiendil.org/) — look there to see all the features in action.
- Sources of the blog: https://github.com/Tiendil/tiendil-org-content — look there to see how content is organized.

Or run from the root of the repository:

```bash
poetry install

./bin/dev-server.sh
```

## Features

- Markdown as a source code for articles.
- Multi-language support by design.
- Mobile-friendly.
- SEO-friendly.
- No cookies.
- Monolithic design: install and run. No need to look for plugins and themes.

### Some specific features

Brigid is not a static site generator, i.e. you should run brigid process to access the site. It gives some advantages over classic static site generators.

- Redirects.
- Nice tags filtering (for wide pages only, for now).
- Detect language by headers.
- Sentry reporting.
- More features are coming.

## Design principles

A very subjective list of design principles I follow in this project:

- One solid, stable, simple, up-to-date solution. Just install and run.
- Markdown won => use markdown as the primary source for posts.
- TOML won => use TOML for metadata and frontmatter instead of YAML.
- No unnecessary or unused features.
- Design for not trivial posts: long, multilanguage, images, code, etc.
- Server-side rendering is good. Use it as the primary approach.
- Use minimum JS only when it is really required.
- No CSS experiments, only stable verified solutions.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Tiendil/brigid",
    "name": "brigid",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": null,
    "keywords": "blog, blog-engine, site, markdown, cms, content management system, personal site",
    "author": "Aliaksei Yaletski (Tiendil)",
    "author_email": "a.eletsky@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/68/c1/56a66b04020a8fa0349d4ae5b779d48dce10669710186cac2b02a4331349/brigid-0.5.0.tar.gz",
    "platform": null,
    "description": "# Brigid\n\nA simple blog engine, but not simpler than it should be.\n\n## Demo\n\n- My blog: [tiendil.org](https://tiendil.org/) \u2014 look there to see all the features in action.\n- Sources of the blog: https://github.com/Tiendil/tiendil-org-content \u2014 look there to see how content is organized.\n\nOr run from the root of the repository:\n\n```bash\npoetry install\n\n./bin/dev-server.sh\n```\n\n## Features\n\n- Markdown as a source code for articles.\n- Multi-language support by design.\n- Mobile-friendly.\n- SEO-friendly.\n- No cookies.\n- Monolithic design: install and run. No need to look for plugins and themes.\n\n### Some specific features\n\nBrigid is not a static site generator, i.e. you should run brigid process to access the site. It gives some advantages over classic static site generators.\n\n- Redirects.\n- Nice tags filtering (for wide pages only, for now).\n- Detect language by headers.\n- Sentry reporting.\n- More features are coming.\n\n## Design principles\n\nA very subjective list of design principles I follow in this project:\n\n- One solid, stable, simple, up-to-date solution. Just install and run.\n- Markdown won => use markdown as the primary source for posts.\n- TOML won => use TOML for metadata and frontmatter instead of YAML.\n- No unnecessary or unused features.\n- Design for not trivial posts: long, multilanguage, images, code, etc.\n- Server-side rendering is good. Use it as the primary approach.\n- Use minimum JS only when it is really required.\n- No CSS experiments, only stable verified solutions.\n\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "Static site generator.",
    "version": "0.5.0",
    "project_urls": {
        "Homepage": "https://github.com/Tiendil/brigid",
        "Repository": "https://github.com/Tiendil/brigid"
    },
    "split_keywords": [
        "blog",
        " blog-engine",
        " site",
        " markdown",
        " cms",
        " content management system",
        " personal site"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb2c08776682fdd302dfbae0ad0f099ba4018a66b73220d662ae5048c10c541e",
                "md5": "13e85f8bfdc59e65686434a54089c530",
                "sha256": "026ef8b855c41ea0ad5b2238e222bafaa19a604935a8253ad106068d2b4cb586"
            },
            "downloads": -1,
            "filename": "brigid-0.5.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "13e85f8bfdc59e65686434a54089c530",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 70079,
            "upload_time": "2024-03-24T15:56:08",
            "upload_time_iso_8601": "2024-03-24T15:56:08.318779Z",
            "url": "https://files.pythonhosted.org/packages/fb/2c/08776682fdd302dfbae0ad0f099ba4018a66b73220d662ae5048c10c541e/brigid-0.5.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68c156a66b04020a8fa0349d4ae5b779d48dce10669710186cac2b02a4331349",
                "md5": "d209be23c03e4b8e3cb6b284c4e9fe51",
                "sha256": "af7ddd8fe2baa25d8b438b0450fa6c9e8b5091748f103c7870be2964d13ff7b3"
            },
            "downloads": -1,
            "filename": "brigid-0.5.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d209be23c03e4b8e3cb6b284c4e9fe51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 46966,
            "upload_time": "2024-03-24T15:56:10",
            "upload_time_iso_8601": "2024-03-24T15:56:10.071792Z",
            "url": "https://files.pythonhosted.org/packages/68/c1/56a66b04020a8fa0349d4ae5b779d48dce10669710186cac2b02a4331349/brigid-0.5.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-24 15:56:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Tiendil",
    "github_project": "brigid",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "brigid"
}
        
Elapsed time: 0.29658s