See git history for this microblog at https://github.com/sio/microblog-spec/commits/sample
See git history for this microblog at https://github.com/sio/microblog-spec/commits/sample
Editing microblog entries after posting is possible, but it will incur the same consequences as rewriting git history in general: it's fine to do while you're in private, but should be avoided after publishing.
I think such approach works well for microblogs too: people should know that the tweet they are replying to was not edited after they've read it. With non-micro blogs fixing typos and rewording would make git a bad storage medium, yet for microblogs I think it's perfect
Speaking of metadata fields: any number of lines starting with
Microblog- placed at the bottom of commit message will be treated as
metadata for renderer.
This commit message contains some metadata that will be parsed, but is otherwise meaningless to our renderer.
Currently only 'markdown' and 'plaintext' are implemented but anything else may be added in future.
Default markup is defined in microblog.toml (`default.markup`) and can be overriden by adding a metadata field to commit message. For example, this entry will be rendered as plain text even though there are markdown elements (see Microblog-Markup field below)
Currently there are also 'lowercase' and 'uppercase' dummy renderers, but I doubt anyone will actually be using those :)
That's why we have default.drop_header in our microblog.toml! Headers
that match this regex will be silently omitted when rendering your
microblog
There is no limit on line length or the number of lines in git commit messages, but your text editor will probably become upset if you write your message like me here: https://github.com/sio/microblog-spec/raw/sample/text-editor-upset.png
This microblog will use empty git commits to store posts. A lot of tooling already exists around git, and git is very good at keeping records for a long time - this makes it perfect for a hacky microblog!
Very few conventions are required to maintain such blog: https://github.com/sio/microblog-spec
