Skip to content

Exporting as MD fails #131

@timothymcmackin

Description

@timothymcmackin

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions