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

Support import maps #85

Open
jaydenseric opened this issue Jan 13, 2022 · 1 comment
Open

Support import maps #85

jaydenseric opened this issue Jan 13, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@jaydenseric
Copy link

Ideally there would be a way to specify, perhaps in a URL parameter, an import map that goes along with the documented module.

There could be UI to tweak the import map, which would update the parameter in the URL and regenerate the docs.

For example, the docs for this module breaks due to the bare react import specifier:

https://doc.deno.land/https://unpkg.com/[email protected]/waterfallRender.mjs

That module works great in Deno projects with an import map that assigns a Preact ESM URL to the react specifier.

I would absolutely 😍 love 😍 to be able to just link to Deno docs in the readme for all my universal Node.js/Deno packages that rely on import maps, instead of maintaining complicated API docs markdown by hand. Hardcoded docs can have mistakes that get permanently published for that package version; whereas having docs generated on demand allows them to just get better and better over time as Deno docs improves, for all versions of the package.

@kitsonk kitsonk added the enhancement New feature or request label Jan 13, 2022
@kitsonk
Copy link
Contributor

kitsonk commented Jan 13, 2022

It is a useful feature.

I can see adding support for a query parameter like ?im=https://example.com/import_map.json or something like that.

Need to check to see how we need to expose it from deno_doc in the JavaScript API and then flow that through to the app.

@kitsonk kitsonk self-assigned this Jan 13, 2022
@kitsonk kitsonk removed their assignment Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants