DavidWells / DavidWells/markdown-magic

Add value from environment variable

Open
#58 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
868
Forks
223
PR merge metrics
No merged PRs in 30d

Description

I want to add automatic generated values from build process into my MD files (i.e. versions determined while build) without the need to implement an own extension. Referencing those values i.e. as

<!-- AUTO-GENERATED-CONTENT:START (ENV:name=myFooVariable) -->
<!-- AUTO-GENERATED-CONTENT:END -->

would allow me to add variable like

myFooVariable=42 md-magic --path './**/*.md'

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.

Research direction

The issue names no implementation file or test. Start by locating the comment-block processing entry point in markdown-magic and trace how custom transforms or external data are handled. Done should be an ENV:name reference that expands from a shell-provided variable, such as myFooVariable=42, when processing the selected Markdown files.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.