Skip to content
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.

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

Exporting as MD fails #131

Open
timothymcmackin opened this issue Sep 30, 2022 · 1 comment
Open

Exporting as MD fails #131

timothymcmackin opened this issue Sep 30, 2022 · 1 comment

Comments

@timothymcmackin
Copy link

The docs say that I can export from Bluehawk with --format md, but when I try to, I get an error.

I created this simple JS file and named it bhtest.js:

// :snippet-start: hello-world
console.log('hi!');
// :snippet-end:

Then I ran this command:

npx bluehawk snip --format md --output ./bhOutput bhtest.js

I get this error:

bluehawk snip <paths..>

extract snippets

Options:
      --version   Show version number                                  [boolean]
      --plugin    add a plugin                                          [string]
      --help      Show help                                            [boolean]
  -f, --format    generate code snippets with markup formatting, e.g. emphasized
                  lines, specified language
                                         [string] [choices: "rst", "docusaurus"]
  -o, --output    the output directory                       [string] [required]
      --id        select snippets with a specific id                    [string]
      --state     select snippets etc. from the given state             [string]
  -i, --ignore    ignore a certain file pattern (like gitignore) when traversing
                  project files. Provide paths relative to project root.[string]
      --logLevel  set the reporter log level. 0=none, 1=errors only, 2=warnings
                  & above, 3=all                                        [number]

Invalid values:
  Argument: format, Given: "md", Choices: "rst", "docusaurus"

Did MD not make it into the 1.3.1 release? When I run npx bluehawk --version I get 1.3.1.

@cbush
Copy link
Collaborator

cbush commented Oct 21, 2022

Hi @timothymcmackin, thanks for raising an issue! Sorry for the delayed reply, I was away. We'll get this fixed up. Meanwhile, you should be able to use --format docusaurus to generate an md file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants