kjaymiller/render-engine-microblog

MIcroblog custom collection for Render Engine

Render Engine Microblog Parser

This is a parser to create a microblog using Render Engine. This is based on the Blog Custom Collection.

This follows the guidance used by Micro.blog which is to be a post with no title. Slugs by default are the slugified datetime string in YYYYMMDDHHMMSS format.

This also create an RSS feed that you can use to syndicate your microblog posts to other services.

Your content is expected to use render engine's MarkdownPageParser or a derivative which is markdown with frontmatter. A date field is the only required metadata for the page object.

---
date: 2023-01-01 12:00:00
---

Hello **World**! 

Installation

Install using pypi. If you haven't already, install render-engine

pip install render-engine render-engine-microblog

Usage

Import the parser and collection

In your render_engine config file import the MicroBlog collection class.

from render_engine import Site
from render_engine_microblog import MicroBlog

Create a collection for your site

Create your collection like you would a blog. You will need to pass a content_path.

site = Site()

@site.collection
class MicroBlog(MicroBlog):
    content_path = "content/microblog"

render-engine-microblog's Issues

Fix tests import in GH Actions

Currently it's loading requirements which is way more than what is needed.

Instead of managing requirements.txt and pyproject.toml we can import the package locally with the dev extra.

python -m pip install -e ".[dev]"

Replace `PageParser` with `Parser`

Remove deprecation warning by replaceing PageParser in the Microblog Collection with Parser

Fix Workflow testing to pass

================================================================ short test summary info ================================================================
FAILED tests/test_collection.py::test_microblog_post_content_is_content - TypeError: MarkdownPageParser.parse() got an unexpected keyword argument 'page'
ERROR tests/test_collection.py::test_microblog_site_page - TypeError: MarkdownPageParser.parse() got an unexpected keyword argument 'page'
ERROR tests/test_collection.py::test_microblog_site_loads_theme - TypeError: MarkdownPageParser.parse() got an unexpected keyword argument 'page'
ERROR tests/test_collection.py::test_microblog_archive_uses_microblog_theme - TypeError: MarkdownPageParser.parse() got an unexpected keyword argument 'page'

Update to Render Engine 2024.1.1a1 for development

So that we can start developing towards the new stable which changes how some testing will work.

How to Fix

In pyproject.toml replace the version on render_engine to render_engine>=2024.1.1a1

Archive Collection has default template as a theme

Add prefix to the theme to avoid conflicts with other themes.

Render Engine has added a prefix attribute to the theme to avoid conflicts with other themes. This helps to ensure that theme components can always be accessed by their unique path.

Use new `render_engine_markdown` parser

replace the import in https://github.com/kjaymiller/render-engine-microblog/blob/39a4659cc439e30b5dfee45ba4b146ac121d9735/render_engine_microblog/collection.py#L3C1-L3C62

to from render_engine_markdown import MarkdownPageParser

also you will need to add render_engine_markdown in the dependencies list in pyproject.toml

Add Docs to Project

Website that can be pointed to for docs

Remove requirements.txt

Remove the requirements.txt file. It is not needed for this project.

add microblog_post to collection_template

Replace Ruff Action with one from render-engine/render-engine

The ruff action doesn't attempt to fix and doesn't push changes.

I developed an action that's used in many of the Render-Engine

https://gist.github.com/kjaymiller/af11a3ee6ef1d56500290b2a05c994c1.

This can be used in the place of the existing lint.yml

To Complete

• Swap the currently lint.yml with one in the gist.