Markdown support#

Markdown is a plain-text format for writing structured content with lightweight syntax. For example, headings, lists, links, code blocks, and tables can be written directly in text files and rendered as formatted HTML.

Sysand Index supports GitHub Flavored Markdown for project content such as bundled README.md and CHANGELOG.md files, rendered on the project page and its Changelog tab.

GitHub Flavored Markdown includes common Markdown syntax plus extensions such as tables, fenced code blocks, task lists, and automatic links. For the full syntax, see the GitHub Flavored Markdown specification. Fenced code blocks are syntax highlighted according to their info string, such as ```python.

As an implementation detail, content is rendered with the same readme-renderer pipeline that PyPI uses for Python package READMEs.

HTML sanitization#

Rendered HTML is sanitized against an allowlist. Common formatting tags (headings, lists, tables, images, details/summary, task-list checkboxes, and similar) are kept. Disallowed tags and attributes such as script, iframe, style, form, event handlers, and inline styles are stripped, and only http and https link targets survive.

If a bundled file cannot be rendered, the content is omitted from the project page rather than shown raw.