Common questions, troubleshooting tips, and solutions for developing documentation with Metupy.
1. Rendering & Formatting
Python's markdown library ignores inline Markdown syntax when wrapped inside raw HTML block elements (e.g., <div> tags used by components).
Solution: Use standard HTML tags like <strong>, <em>, or <code> directly inside component text properties, or convert the string via markdown.markdown() before passing it.
2. Server & Environment
Pass the --port option directly to the CLI command:
metupy dev --port 8080
Place static files inside the assets/ directory at your project root. The engine automatically serves them via /assets/<filename>.
3. Components & Dynamic Imports
Metupy uses dynamic file resolving. Ensure the Python filename inside components/ matches the class name in snake_case (e.g., class CustomBadge should be in components/custom_badge.py).
Tip: If you are referencing a built-in blueprint component, add it to your project first using metupy add <component_name>.
4. Build & Deployment
Yes! Execute metupy build to render all Python pages into static HTML and Markdown files inside the dist/ folder.
Still Need Help?
If you run into bugs or unsupported use cases, feel free to submit an issue or discussion on the official Metupy GitHub repository.