Skip to content

FR: Enable extensions for rendering of README.md #1544

@duskmoon314

Description

@duskmoon314

Currently, README.md is rendered using comark::Options::default() (src):

if ext == "md" {
  markdown_to_html(
    &std::fs::read_to_string(entry.path())?,
    &ComrakOptions::default(),
  )
}

Thus, common structures like table are not rendered. It would be convenient to enable some of the extensions in comrak::options::Extension.

For backward compatibility, maybe add an argument --readme-extensions and let users choose which extension is enabled.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions