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

runme CLI fails on certain formats of markdown #723

Open
agardnerIT opened this issue Dec 30, 2024 · 0 comments
Open

runme CLI fails on certain formats of markdown #723

agardnerIT opened this issue Dec 30, 2024 · 0 comments

Comments

@agardnerIT
Copy link

Not sure this is a bug or "as designed"...

I'm writing documentation with mkdocs material and one of the concepts available are snippets. Snippets are denoted with a special "scissor" syntax to include the given file:

--8<-- "include-me.md"

Broken Markdown

This markdown (starting with a snippet) produces no code blocks.

Note: I've added backspaces(\) just to keep GitHub issues formatting happy, they aren't there in the real doc.

--8<-- "snippets/live-code-snippets-button-executor.md"

## Import Dynatrace Dashboard

\``` {"name": "docker ps"}
docker ps
\```

Executing runme ls:

runme --filename docs/run-demo2.md ls --json
null

Side note: Shouldn't it return [] not null.

runme --filename docs/run-demo2.md ls returns textual no code snippets text.

Working Markdown

  • Remove the scissor snippet line and runme ls works perfectly ✅
  • Place the scissor snippet anywhere after the first title and runme ls works perfectly ✅
## Import Dynatrace Dashboard

\``` {"name": "docker ps"}
docker ps
\```

--8<-- "snippets/live-code-snippets-button-executor.md"

Shows:

runme --filename docs/run-demo2.md ls --json
[
  {
    "name": "docker ps",
    "file": "docs/run-demo2.md",
    "first_command": "docker ps",
    "description": "",
    "named": true,
    "run_all": true
  }
]
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

1 participant