Skip to content

v0.4.0

Choose a tag to compare

@github-actions github-actions released this 08 Oct 13:37
· 87 commits to main since this release
563377d

markz now aims to have no footguns. Every input does what it looks like, or gets a warning that
says what to write. Formatters and GitHub may show a document differently, but they must not
damage it.

What to change

Before Now What to do
"quotes", -- and ... became “”, – and … Text is kept as typed Type the character you want, or curl text in your own pass over the tree.
deploy.name: x gave { deploy: { name: "x" } } { "deploy.name": "x" }, with no warning Read metadata["deploy.name"]. metadata.deploy is now undefined, so search for it.
title: Hi # note dropped the comment Kept as written, with metadata-value Quote the value, or put the comment on its own # line.
draft: no, on and off were strings, 1.10 was 1.1 metadata-value, and the key skipped Write true or false, or quote the value.
The metadata-indented code metadata-line Match the new code.
MetadataValue could be a nested object A scalar, or a list of scalars Drop the object case.

What's Changed

Breaking

  • Smart punctuation removed; metadata keys are flat; *** is a rule by @amitkaps in #116
  • Metadata keeps a value with # or : as written, with a warning; every YAML number form warns by @amitkaps in #121

Added

  • Warnings for * between digits, element lines a formatter would move, and ${…} closed early by @amitkaps in #115

Fixed

  • A fence's info string splits before references decode by @amitkaps in #110

Faster and smaller

  • Faster headings and tables: one-line leaves with no syntax skip the inline pass by @amitkaps in #97
  • A parsed tree takes less memory: arrays sized to its nodes by @amitkaps in #107
  • A parsed tree takes less memory: code blocks and text read from the source by @amitkaps in #108

Documentation

  • README: a small, opinionated Markdown, and the one package that reads it by @amitkaps in #94
  • Docs: a Quality page, with how to read the report and how markz is tested by @amitkaps in #103
  • Docs: import markz in the browser from a CDN by @amitkaps in #105
  • Docs: syntax.md opens with the language at a glance; exact rules move to the grammar by @amitkaps in #118
  • Docs: bare attribute keys, and where they count on their own by @amitkaps in #120

Full Changelog: v0.3.0...v0.4.0