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

feat: proof-of-concept API doc generation for jspm.org #22

Merged
merged 5 commits into from
Mar 2, 2023

Conversation

Bubblyworld
Copy link
Contributor

@Bubblyworld Bubblyworld commented Feb 24, 2023

See #23. Adds a script that generates API documentation for @jspm/generator using
typedoc and spits in out into the public_html/api/generator directory. We can
change it easily to support versioning and the rest of the @jspm packages,
but we'll have to wire each package we want to support with a tsconfig.json
and a typedoc.json file.

At the moment I haven't added any links to the new docs, but you can see them
by going to the /api/generator path.

@Bubblyworld
Copy link
Contributor Author

The default theme:

Screenshot 2023-02-24 at 17 03 13

Screenshot 2023-02-24 at 17 03 27

Screenshot 2023-02-24 at 17 03 39

@Bubblyworld
Copy link
Contributor Author

Screenshot 2023-02-27 at 11 22 37

Screenshot showing dark mode and version box.

@Bubblyworld Bubblyworld merged commit ba5c335 into jspm:main Mar 2, 2023
@Bubblyworld Bubblyworld deleted the guy-api_docs branch March 2, 2023 10:55
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.

1 participant