-
Notifications
You must be signed in to change notification settings - Fork 0
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
Added CLI command for API docs. #34
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a big PR, so I spent more time testing rather that looking though code.
This is great because it looks and works like the rest of the Highcharts API Reference, and also works offline.
Requested changes:
Some things on the API docs website at localhost:8005 did not work like I expected:
-
Navigating directly to an option (e.g. http://localhost:8005/RNANews.localization.currency) does not work. The home page is shown instead. This also means the links in the div#body does not work.
-
The class reference does not exist.
- If this is not to be implemented: Consider hiding this link.
- If it is to be kept: consider a different text. It now reads
For modifying the chart at runtime. See the [class reference](http://localhost:8005/class-reference/classes.list).
- Missing copyright year and version in footer
- The search field does not work. Console shows
404 search.json
- Clicking “JS API Reference” in the top header links to the incorrect page which does not exist:
-
Edit button on the options link to the wrong page on GitHub: https://github.com/highcharts/highcharts/blob/vundefined/src/RNANews/RNANewsOptions.ts
-
GitHub logo/link in the footer links to Highcharts repository. I expected it to link to the
connectors-morningstar
repository.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is excellent – well done!
Use
npx connectors-morningstar api
.