Skip to content

Update documentation and CLI to match options order #41

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.

Sign up for GitHub

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

Merged
sindresorhus merged 1 commit into from
Nov 17, 2024
Merged

Update documentation and CLI to match options order #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ const cli = meow(
and dark themes match or if type is not 'auto'
--only-style Only output the styles, forces --preserve-variables on
--only-variables Only output the variables for the specified themes
--root-selector Specify the root selector when outputting styles, default '.markdown-body'
--no-use-fixture Exclude generated classes that come from GitHub Markdown API rendered fixture.md
--root-selector Specify the root selector when outputting styles, default '.markdown-body'

Examples
$ github-markdown-css --list
Expand Down
3 changes: 3 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ console.log(await githubMarkdownCss({
// `preserveVariables` to be `true` and ignores the theme values.
// Useful to get the base styles to use multiple themes.
onlyStyles: false,
// Include extra styles from GitHub Flavored Markdown, like code snippets.
useFixture: true,
// Set the root selector of the rendered Markdown body as it should appear
// in the output CSS. Defaults to `.markdown-body`.
rootSelector: '.markdown-body',
Expand Down Expand Up @@ -76,6 +78,7 @@ $ github-markdown-css --help
and dark themes match or if type is not 'auto'
--only-style Only output the styles, forces --preserve-variables on
--only-variables Only output the variables for the specified themes
--no-use-fixture Exclude generated classes that come from GitHub Markdown API rendered fixture.md
--root-selector Specify the root selector when outputting styles, default '.markdown-body'

Examples
Expand Down