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

docs: Add 'No-Build Workflows' doc, focusing on importmaps (for now) #1175

Merged
merged 5 commits into from
Aug 13, 2024

Conversation

rschristian
Copy link
Member

Partially address #1116

Copy link
Member

@marvinhagemeister marvinhagemeister left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for adding this!

content/en/guide/v10/importmaps.md Outdated Show resolved Hide resolved
Comment on lines 108 to 118
<script type="importmap">
{
"imports": {
"preact": "https://esm.sh/[email protected]",
"preact/": "https://esm.sh/[email protected]/",
"react": "https://esm.sh/[email protected]/compat",
"react/": "https://esm.sh/[email protected]/compat/",
"react-dom": "https://esm.sh/[email protected]/compat",
"@mui/material": "https://esm.sh/@mui/material?external=react,react-dom"
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just push for this one instead of the ?alias think. I've found that people are less likely to shoot themselves in the foot with this looking at past support questions in Fresh.

Copy link
Member Author

@rschristian rschristian Aug 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, sounds good.

Any other situations and/or examples you want to see added to help Fresh people? I realize there's been a fair bit of struggling over there so if our docs could help at all, that'd be great. I did take a quick skim but it seemed to (largely) be people struggling with specific dependencies rather than anything major conceptually.

For a more full example, see [Using Preact with HTM and ImportMaps](#using-preact-with-htm-and-importmaps), and for more information on HTM, check out its [documentation][htm].
For a more scalable solution, see [Import Maps -- Basic Usage](/guide/v10/no-build-workflows#basic-usage), and for more information on HTM, check out its [documentation][htm].
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to refer to import maps as more scalable? Obviously HTTP imports have "issues", but I'm not sure of the language here.

@@ -0,0 +1,123 @@
---
name: No-Build Workflows
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Switched this over to 'No-Build Workflows' instead, as an importmap-specific page felt unnecessary. Granted, this might be a bit confusing for Deno users, but I felt that the ability to more info here in the future for buildless workflows is of more benefit.

Will think on it, anyhow. Opinions certainly welcome (as always).

@rschristian rschristian changed the title docs: Add importmap doc docs: Add 'No-Build Workdflows' doc, focusing on importmaps (for now) Aug 10, 2024
@rschristian rschristian changed the title docs: Add 'No-Build Workdflows' doc, focusing on importmaps (for now) docs: Add 'No-Build Workflows' doc, focusing on importmaps (for now) Aug 10, 2024
@rschristian rschristian marked this pull request as ready for review August 11, 2024 23:20
@rschristian rschristian merged commit d87bef4 into master Aug 13, 2024
5 checks passed
@rschristian rschristian deleted the docs/advanced-importmaps branch August 13, 2024 20:28
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.

2 participants