Add a plugin for variable support in Markdown #554
Conversation
mhelf-intel
requested review from
adobrzyn,
afierka-intel,
iboiko-habana,
kzawora-intel,
mgawarkiewicz-intel,
michalkuligowski,
mswiniarsk,
vivekgoe and
xuechendi
as code owners
🚧 CI BlockedThe main CI workflow was not started for the following reason:
|
mhelf-intel
added
documentation
🚧 CI BlockedThe main CI workflow was not started for the following reason:
|
mhelf-intel
force-pushed
the
doc-variables
branch
from
c18b399 to
570316c
Compare
| MODEL="Qwen/Qwen2.5-14B-Instruct" \ | ||
| HF_TOKEN="<your huggingface token>" \ | ||
| DOCKER_IMAGE="vault.habana.ai/gaudi-docker/|Version|/ubuntu24.04/habanalabs/vllm-installer-|PT_VERSION|:latest" | ||
| DOCKER_IMAGE="vault.habana.ai/gaudi-docker/|Version|/ubuntu24.04/habanalabs/vllm-installer-{{ PT_VERSION }}:latest" |
There was a problem hiding this comment.
hmm doesnt seem to work in the preview mode - https://github.com/vllm-project/vllm-gaudi/blob/570316cdf817288500cbd337349dbf65811c9417/docs/getting_started/quickstart/quickstart.md
There was a problem hiding this comment.
Yes, this solution works with mkdocs, so generates the values on the documentation website, not in GitHub preview. Is the preview support required? It seems to me that users should be encouraged to mainly use the doc website. If support in both places is required, then it may be simpler to use plain values and update them manually when they change.
mhelf-intel
force-pushed
the
doc-variables
branch
from
013d9ab to
b755c05
Compare
Signed-off-by: mhelf-intel <monika.helfer@intel.com>
mhelf-intel
force-pushed
the
doc-variables
branch
from
b755c05 to
f5abf29
Compare
🚧 CI BlockedThe main CI workflow was not started for the following reason:
|
3 participants
This plugin supports using variables in Markdown, which is useful for defining some values or versions (such as PT_VERSION) in one place. I tested it locally and it's working correctly:
