Document preview shortcuts #12664
Document preview shortcuts #12664
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ArmandPhilippot
left a comment
ArmandPhilippot
left a comment
There was a problem hiding this comment.
I'm mentioning this in case anyone else has the same hesitation (ie. this could be a sign that this needs to move): I'm not sure if this should be displayed after or before the "Since Astro 1.5.0". I guess both works!
Except that hesitation, I left a suggestion due to a rendering issue but thanks, this looks good to me!
ArmandPhilippot
added
improve or update documentation
Co-authored-by: Armand Philippot <[email protected]>
| - o + enter to open your Astro site in the browser. | ||
| - q + enter to quit the preview server. | ||
|
|
||
| Can be combined with the [common flags](#common-flags) documented below. |
There was a problem hiding this comment.
Now this looks like the hotkeys can be combined with the common flags below. This list should go somewhere else to avoid confusion. I'd actually put it before the note about the Node adapter, which is pretty specific compared to general information about hotkeys.
There was a problem hiding this comment.
And now that I think about it more, I don't even think we need that Node line at all? I think that was probably introduced when on-demand rendering was new. But it feels totally unnecessary now. What do you think, @ArmandPhilippot ? ("Since Astro v1, it does this thing that everyone totally expects it to do." 😂 )
There was a problem hiding this comment.
Yeah, I think it's old enough to no longer say that about Node.
I wasn't totally sure about putting them in common flags though, because they are specific to dev/preview and both doesn't have the exact same hotkeys? (e.g. s + enter only works with dev).
But after reflection, it might simply be a matter of wording, and adding an "Hotkeys" section to the common flags would make them easier to find. Good idea!
|
Just made a commit to:
I think this is probably fine, but happy to have any opinions/suggestions to further edit this! @jacobdalamb @ArmandPhilippot - Anything here you'd change or object to? |
ArmandPhilippot
left a comment
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Looks good to me!
I left a suggestion because we might need inline code for the hotkeys (as we do in astro dev), I forgot that in my initial review...
Co-authored-by: Armand Philippot <[email protected]>
|
LGTM |
|
Excellent! Seems we're good for 5.16 release here! It's in the milestone, and we'll merge it then. |
sarah11918
added
the
Merge Queue
6 participants
Description (required)
Document shortcuts for
astro previewRelated issues & labels (optional)
For Astro version:
5.16. See astro PR withastro/astro#14574.