Skip to content

Improve documentation #55

Description

@devnote-dev

I think it's safe to say that the majority of the library is undocumented or is lacking sufficient documentation. This isn't really useful if you're trying to implement a custom renderer which has many methods, or even make use of the parsers. Adding doc comments to the necessary classes/methods/etc would resolve this (maybe with examples too?), then possibly having the docs hosted? Of course, this isn't required, but it's definitely a plausible solution.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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