Explore: Go templates for includes and page manipulation

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

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Quiet
Tech stack
go
Domain
cli

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.

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.

Dominant language
Go
Stars
2
Forks
0
Avg merge
2h 5m
Merged PRs (30d)
50

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.

More from mozilla/markfluence

All issues in mozilla/markfluence

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.