Skip to content

Commit

Permalink
Update documentation and CLI to match options order (#41)
Browse files Browse the repository at this point in the history
  • Loading branch information
earlAchromatic authored Nov 17, 2024
1 parent 0d3ec26 commit 994fb54
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion cli.js
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
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

0 comments on commit 994fb54

Please sign in to comment.