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.

Sign up for GitHub

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

Jump to bottom

Add central place to define version numbers + support for variables in markdown #105

Open
greenbreakfast opened this issue Jun 6, 2024 · 1 comment
Open

Add central place to define version numbers + support for variables in markdown #105

greenbreakfast opened this issue Jun 6, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@greenbreakfast
Copy link
Contributor

The Idea

Since version numbers (like OpenWRT 23.05.3, and NodeJS v16.19) change fairly often and are included in several articles, it would be nice to:

  1. Have a central place to define all of these values (like a JSON file or similar)
  2. Enable support for variables in markdown rendering
  3. Update articles to use variables instead of hard-coding version numbers

That way, when a version number changes, only one file has to be manually updated and the rendered documentation site will be updated in all places the version number is used.

Execution

Need more research to figure out how to do this
@greenbreakfast greenbreakfast added the enhancement New feature or request label Jun 6, 2024
@greenbreakfast greenbreakfast moved this from Completed to Backlog in Omega2 Beta Documentation Improvement Oct 17, 2024
@greenbreakfast
Copy link
Contributor Author

Implementation Research

Use preprocessor suggestion from facebook/docusaurus#395 (comment)
Tested with existing 2.4.3 Docusaurus, didn't work

Requires upgrade to Docusaurus 3.x

greenbreakfast added a commit that referenced this issue Oct 17, 2024
@greenbreakfast
added valid placeholder variable definitions - cc #105
9defd4d
@greenbreakfast greenbreakfast changed the title Add central place to define version numbers + support for variables in markdwon Add central place to define version numbers + support for variables in markdown Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
Omega2 Beta Documentation Improvement
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@greenbreakfast @amsiotdeveloper