https://github.com/mloubout/critic-markup

Critic markup filter for quarto
https://github.com/mloubout/critic-markup

critic-markup lua-filters quarto quarto-extension quarto-filter

Last synced: 16 days ago
JSON representation

Critic markup filter for quarto

• Host: GitHub
• URL: https://github.com/mloubout/critic-markup
• Owner: mloubout
• License: mit
• Created: 2023-05-05T12:40:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-27T22:47:59.000Z (4 months ago)
• Last Synced: 2024-10-13T19:40:11.224Z (about 1 month ago)
• Topics: critic-markup, lua-filters, quarto, quarto-extension, quarto-filter
• Language: Lua
• Homepage: https://mloubout.github.io/critic-markup/
• Size: 1.39 MB
• Stars: 22
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Critic-markup Extension For Quarto

This extension provide a filter for processing [critic markup](https://github.com/CriticMarkup/CriticMarkup-toolkit) syntax when rendering to html. The rendered html provide a flexible interface with

- The markup document with changes highlighted

- The original version

- The updated version with the changes applied

This extension was inspired by the critic markup processing for [ScholarlyMarkdown](http://scholarlymarkdown.com/) available under MIT license as well [ScholarlyMarkdown.git](https://github.com/slimgroup/ScholarlyMarkdown)

## Installing

```bash

quarto add mloubout/critic-markup

```

This will install the extension under the `_extensions` subdirectory.

If you're using version control, you will want to check in this directory.

## Using

To use this extension, simply add it to your header as a filter

```yaml

---

title: Markup example

filters:

  - critic-markup

---

```

## Example

Here is a minimal example showing the critic markup syntax and its rendering: [example.qmd](example.qmd).

This is the output of [example.qmd](https://mloubout.github.io/critic-markup/).