Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not working #5

Open
riyadshauk opened this issue Oct 12, 2018 · 0 comments
Open

Not working #5

riyadshauk opened this issue Oct 12, 2018 · 0 comments

Comments

@riyadshauk
Copy link

riyadshauk commented Oct 12, 2018

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant