Skip to content

Feedback on the v4 default html theme #469

@targos

Description

@targos

Hello and thanks for making this very nice project!

I am trying to build the documentation for a few projects using the latest beta release and have a few comments / questions.

Here is the generated doc sit as a reference: http://image-js.github.io/core/
I used the following command: documentation build src/index.js --github --output doc --format html

Filter

I think it would be nice to auto-expand the class if a matching method is found.

Currently:
image
Expected:
image

GitHub option

Our project only exports a few classes and the important stuff is in the methods. We also split the method definitions in many different files.
Therefore, it would be much better to have a link a the level of each method instead of just a the class definition.

Methods

There seems to be a bug in the output for class methods. Only the name is displayed with no further information. Clicking on it adds a little caret but nothing happens if we try to open it.
image

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