Explore: Go templates for includes and page manipulation
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 0
- Avg merge
- 2h 8m
- Merged PRs (30d)
- 49
Description
Investigate using Go templates (text/template) for markdown includes, reusable snippets, and page manipulation.
This generalizes the current comment-directive tokens (<!-- confluence-toc -->, <!-- markfluence-version -->), which were added as simple string substitutions inside MdToConfluence with the intent to revisit as templates.
Explore:
- What templating buys (includes, variables like version/date, conditionals).
- Where it fits in the convert pipeline (pre-parse expansion vs. token substitution).
- Security (template injection, file includes escaping the docs tree).
- API/authoring design and how it interacts with raw storage passthrough.
Deliverable: a design proposal.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with MdToConfluence and the current comment-directive string substitutions for confluence-toc and markfluence-version. Trace where expansion could fit relative to parsing and raw storage passthrough, then assess includes, variables, conditionals, security, and authoring/API concerns. Done means a design proposal addressing the listed trade-offs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100