docs: Expand + clarify --embed docs, esp. for usage without alias
#206
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add documentation of unaliased embed behavior * Add example for unaliased/merged embedded directories
mohammed90
approved these changes
Sep 23, 2024
mholt
reviewed
Sep 23, 2024
|
|
||
| ``` | ||
| $ xcaddy build --embed foo:./sites/foo --embed bar:./sites/bar | ||
| ```sh |
There was a problem hiding this comment.
Not sure if this is actually what we want, given that most of the content is not shell commands, but rather some output (that happens to be a Caddyfile). Unless the highlighter is smart enough to parse the difference? (Same below)
There was a problem hiding this comment.
I totally agree and had actually meant to remove this before submitting, but just noticed that my push to my fork timed out and I didn't notice before I hit the button 😭 I'll send a followup in a second
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Another small docs PR for
--embedflag usage 🎏My main goal here was to add documentation for the way
--embedbehaves without an alias for the source directory, which writes the contents of the source directory into the root* of the embedded FS without any containing subdirectory. This behavior, while perfectly ergonomic for making a file server, had confused me briefly as a new user (see #202).Since the
--embedexamples in the README have been expanded + annotated, I removed the inline example from the command usage text in the source code. I think using this space for text that documents the unaliased behavior is worth it, but I'm happy to re-add the inline example if preferred.*yes, technically into the
/filesintermediate dir, but this is the root from the user's perspective