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

api index #1765

Merged
merged 3 commits into from
Jul 29, 2023
Merged

api index #1765

merged 3 commits into from
Jul 29, 2023

Conversation

mbostock
Copy link
Member

@mbostock mbostock commented Jul 22, 2023

Fixes #1752.

Enumerates every method with a brief description pulled from the documentation:

Screenshot 2023-07-26 at 4 09 09 PM

Also enumerates every option, showing which interface the option is defined:

Screenshot 2023-07-26 at 4 09 58 PM

It would perhaps be better to provide more specific links (e.g., to the #bend anchor fragment instead of the general arrow mark documentation), but I think that’s non-blocking and we could add that in the future as desired.

@mbostock mbostock force-pushed the mbostock/api-index branch from c8a5cb5 to 0306ed8 Compare July 26, 2023 23:08
@mbostock mbostock requested a review from Fil July 26, 2023 23:11
@mbostock mbostock marked this pull request as ready for review July 26, 2023 23:11
@mbostock
Copy link
Member Author

Trying this for now. Let me know if you want changes. I think I’d like to use shorter, explicit anchor fragments across the site, for example, such as #pointerX instead of #pointerx-options.

@mbostock mbostock merged commit a81b65e into main Jul 29, 2023
@mbostock mbostock deleted the mbostock/api-index branch July 29, 2023 16:03
@Fil
Copy link
Contributor

Fil commented Jul 31, 2023

Love it!

Fil pushed a commit that referenced this pull request Aug 21, 2023
* api index

* fix crosshair link

* externalize list style
chaichontat pushed a commit to chaichontat/plot that referenced this pull request Jan 14, 2024
* api index

* fix crosshair link

* externalize list style
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

Successfully merging this pull request may close these issues.

API index
2 participants