Skip to content

Document stable API #9

Description

@nichtich

The README.md should document the exported API, at least the main functions. It looks like some internal stuff is also exported, I'd limit to the subset of stable functions:

  • readCFF
  • writeCFF
  • validateCFF and validateCFFFile

MyST conversion should be exported under a different name such as mystFrontmatterToCFF and mystFrontmatterToCFFReference to make clear it is about MyST format.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions