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.

Sign up for GitHub

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

Jump to bottom

link to the API docs in the README.md? #295

Open
Pomax opened this issue May 11, 2019 · 3 comments
Open

link to the API docs in the README.md? #295

Pomax opened this issue May 11, 2019 · 3 comments
Labels
docs enhancement

Comments

@Pomax
Copy link

Pomax commented May 11, 2019

I don't see a link in the README.md that lets people get to the docs that cover the API for this package... can that be added?
@rattrayalex-stripe
Copy link

It looks like the api docs for the main package are here: https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/index.md

other packages here: https://github.com/inikulin/parse5/blob/master/docs/list-of-packages.md

@Pomax
Copy link
Author

Pomax commented Feb 29, 2020 •
edited
Loading

It does, but I'm far less interested in "finding those links" as I am making sure everyone can find them because they're listed in the main readme.

@Pomax
Copy link
Author

Pomax commented Feb 29, 2020 •
edited
Loading

filed #311

@Pomax Pomax mentioned this issue Mar 3, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Pomax @inikulin @rattrayalex-stripe