8000 TOC links don't work in API docs · Issue #496 · zlib-ng/minizip-ng · GitHub
[go: up one dir, main page]

Skip to content

TOC links don't work in API docs #496

Closed

Description

@bug22

It's inconvenient to navigate through the API functions documentation because clicking on the table of contents links does not work due to missing underscores in the names of the corresponding destination anchors.

For example, https://github.com/nmoinvaz/minizip/blob/master/doc/mz_zip_rw.md#mz_zip_reader_open should be reachable through its TOC entry for mz_zip_reader_open, but it isn't, because the anchor name is spelled as #mzzipreaderopen (without underscores) in the TOC.

Activity

  1. joycepg commented on Jun 12, 2020

    @joycepg

    i'm happy to send a pr for this, if is it just editing the .md files manually? or did you use a tool to generate the .md?

  2. nmoinvaz commented on Jun 12, 2020

    @nmoinvaz
    Member

    I will accept a PR. I used a tool. Some plugin for VSCode.

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

    documentationDocumentation updatefixedIssue or bug has been fixed

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0