Skip to content

Not working #5

@riyadshauk

Description

@riyadshauk

Hey, I'm having trouble using this tool. I created a tsconfig.json with a files property with the files that I want to be parsed and API markdown documentation generated for.

I also created a "typings" property in my package.json as such: "typings": "./interfaces/*",... though the file I'm mainly concerned with generating markdown documentation for is just one simple .ts file.

I also copy-pasted the code snippet provided in the charto/readts README.md into my main .ts file. I also placed API with === in my README.md. All I get as a result to running npm run docts is Docs generated using [docts](https://github.com/charto/docts) underneath the API with the ===....

Help? Perhaps improve the documentation by providing a complete and minimal example?

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