Introduction
Tip: edit docs/DOCUMENTATION_INDEX.md to change the curated order, then regenerate with python scripts/build_user_guide_html.py.
Majoor Assets Manager • Documentation • January 2026
{_escape(m.group(1))}'
s = re.sub(r"`([^`]+)`", repl_code, s)
# Images: 
def repl_image(m: re.Match) -> str:
alt = (m.group(1) or "").strip()
url = (m.group(2) or "").strip()
safe_url = url
parsed = urllib.parse.urlsplit(url)
path = (parsed.path or "").replace("\\", "/")
md_name = Path(path).name if path else ""
if md_name not in doc_id_by_md_name:
safe_url = _rel_from_docs(url)
# User guide preference: do not render images. Keep a clickable link instead.
safe_attr = html.escape(safe_url, quote=True)
label = alt or "image"
return f'[{_escape(label)}]'
s = _RE_MD_IMAGE.sub(repl_image, s)
# Links: [text](url)
def repl_link(m: re.Match) -> str:
label = m.group(1)
url = m.group(2).strip()
# Intra-doc anchors: (#heading)
if url.startswith("#"):
anchor = f"#{doc_prefix}-{_slugify(url[1:])}"
return f'{_escape(label)}'
parsed = urllib.parse.urlsplit(url)
path = (parsed.path or "").replace("\\", "/")
frag = parsed.fragment or ""
# Cross-doc md links inside docs/: map to in-page sections.
md_name = Path(path).name if path else ""
if md_name in doc_id_by_md_name:
doc_id = doc_id_by_md_name[md_name]
if frag:
anchor = f"#{doc_id}-{_slugify(frag)}"
else:
anchor = f"#{doc_id}"
return f'{_escape(label)}'
# External links: open in a new tab.
if re.match(r"^https?://", url, flags=re.IGNORECASE):
safe_url = html.escape(url, quote=True)
return f'{_escape(label)}'
# Other relative links (README, scripts, etc.): rewrite relative to docs/.
safe_url = html.escape(_rel_from_docs(url), quote=True)
return f'{_escape(label)}'
s = _RE_MD_LINK.sub(repl_link, s)
# Bold / italic (basic)
s = re.sub(r"\*\*([^*]+)\*\*", r"\1", s)
s = re.sub(r"\*([^*]+)\*", r"\1", s)
return s
def _is_hr(line: str) -> bool:
t = line.strip()
return t in {"---", "***", "___"}
def _looks_like_table_header(line: str, next_line: str) -> bool:
if "|" not in line:
return False
if "|" not in next_line:
return False
sep = next_line.strip()
# Typical md separator: | --- | ---: |
return bool(re.fullmatch(r"\|?\s*:?-{3,}:?\s*(\|\s*:?-{3,}:?\s*)+\|?", sep))
def _split_table_row(line: str) -> list[str]:
# Strip outer pipes if present.
t = line.strip()
if t.startswith("|"):
t = t[1:]
if t.endswith("|"):
t = t[:-1]
return [c.strip() for c in t.split("|")]
@dataclass
class Doc:
file: str
title: str
desc: str
def _docs_from_index(index_md: str) -> list[Doc]:
docs: list[Doc] = []
for line in index_md.splitlines():
m = re.match(r"^\-\s+\[([^\]]+)\]\(([^)]+\.md)\)\s+\-\s+(.*)$", line.strip())
if not m:
continue
title = m.group(1).strip()
file = m.group(2).strip()
desc = m.group(3).strip()
docs.append(Doc(file=file, title=title, desc=desc))
return docs
def _close_lists(list_stack: list[tuple[str, int]], out: list[str], to_indent: int = -1) -> None:
while list_stack and (to_indent < 0 or list_stack[-1][1] >= to_indent):
tag, _ = list_stack.pop()
out.append(f"")
def _flush_paragraph(
buf: list[str], out: list[str], *, doc_prefix: str, doc_id_by_md_name: dict[str, str]
) -> None:
if not buf:
return
text = " ".join(x.strip() for x in buf).strip()
if text:
out.append(f"{_inline_md_to_html(text, doc_prefix=doc_prefix, doc_id_by_md_name=doc_id_by_md_name)}
") buf.clear() def _collect_table_rows(lines: list[str], i: int) -> tuple[list[list[str]], int]: body_rows: list[list[str]] = [] while i < len(lines) and lines[i].strip() and "|" in lines[i]: body_rows.append(_split_table_row(lines[i])) i += 1 return body_rows, i def _sync_list_stack( list_stack: list[tuple[str, int]], out: list[str], tag: str, indent: int ) -> None: if not list_stack: list_stack.append((tag, indent)) out.append(f"<{tag}>") return _cur_tag, cur_indent = list_stack[-1] if indent > cur_indent: list_stack.append((tag, indent)) out.append(f"<{tag}>") return while list_stack and indent < list_stack[-1][1]: _close_lists(list_stack, out, to_indent=list_stack[-1][1]) if list_stack and list_stack[-1][0] != tag: _close_lists(list_stack, out, to_indent=list_stack[-1][1]) list_stack.append((tag, indent)) out.append(f"<{tag}>") def _md_to_html(md: str, *, doc_prefix: str, doc_id_by_md_name: dict[str, str]) -> str: out: list[str] = [] lines = md.replace("\r\n", "\n").split("\n") in_code = False code_lang = "" code_lines: list[str] = [] list_stack: list[tuple[str, int]] = [] # (ul|ol, indent) para: list[str] = [] i = 0 while i < len(lines): line = lines[i] # Fenced code block if line.strip().startswith("```"): _flush_paragraph(para, out, doc_prefix=doc_prefix, doc_id_by_md_name=doc_id_by_md_name) _close_lists(list_stack, out) if not in_code: in_code = True code_lang = line.strip().lstrip("`").strip() code_lines = [] else: in_code = False lang_attr = f' class="language-{_escape(code_lang)}"' if code_lang else "" code_content = _escape('\n'.join(code_lines)) out.append(f"