docs: name the current site-export CLI flag - #9
Merged
Conversation
Glyph renamed it when the CLI grew the other export formats: --export-website <dir> became --export site --out <dir>, and the old spelling was removed rather than deprecated. The site-theme section still told plugin authors to use the removed one. Names both, with the version boundary, since the flag a reader needs depends on which Glyph they have installed.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
The site-theme section of the API reference tells plugin authors to use
--export-website, which Glyph removed. It became--export site --out <dir>when the CLI grew the other export formats, and the old spelling was deleted rather than deprecated, so a reader following this doc after the next release gets a usage error.Changes
docs/api-reference.md: names the current flag, and the old one with its version boundary, since which flag a reader needs depends on the Glyph they have installed.Notes
The same rename is handled in glyph-md/export-website-action#1, which is the other place the removed flag was still live. This is documentation only; no plugin behaviour changes.