pawamoy / pawamoy/markdown-exec

feature: Allow turning on autoexec in mkdocs.yml

Open
#76 3 comments 0 reactions 1 assignee View on GitHub

@pawamoy is already working on this.

Since Feb 21, 2025.

feature insiders
Dominant language
Python
Stars
174
Forks
21
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.

I'd like to be able to MARKDOWN_AUTO_EXEC from a configuration file rather than an environment variable. This is in order to make it easier for a new contributor to a project to naively run mkdocs build without issue, or generally to have all of the build config in files rather than partially in environment variables.

Describe the solution you'd like

When using markdown_exec as a mkdocs plugin there is an option to turn on autoexec from mkdocs.yml

Describe alternatives you've considered

Always setting the environment variable. Will work, but is one extra step and introduces potential for errors when forgetting to do so.

Additional context

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.