Module render 

Rendering: solar AST -> vocs MDX.

Structs

CommentData 🔒

Ctx 🔒

Description 🔒

Enums

DescKind 🔒

Functions

collect_comments 🔒

Collect natspec from doc comments, applying inline link replacement.

contract_kind_str 🔒

dedent 🔒

Strip common leading whitespace from all non-empty lines.

escape_table_cell 🔒

Escape a value so it is safe inside a markdown (GFM) table cell:

find_contract_id 🔒

Find the HIR ContractId for a contract by name, requiring the contract to live in the source file currently being rendered (compared via absolute path) so contracts that share a file stem across src/ and lib/ cannot collide.

first_notice 🔒

function_heading 🔒

function_signature_anchor 🔒

inheritdoc_base 🔒

Returns the base contract name from @inheritdoc Base, or None.

is_known_custom_tag 🔒

Returns true if tag looks like a generally-recognised natspec custom tag.

italicize_dev 🔒

Italicize a @dev block by wrapping it in <i>...</i> HTML tags. Surrounding blank lines around the tags ensure MDX/CommonMark parses the inner content as block-level markdown (lists, code fences, multiple paragraphs all work).

render_constants 🔒

render_contract 🔒

render_enum 🔒

render_error 🔒

render_event 🔒

render_free_functions 🔒

render_function_section 🔒

render_struct 🔒

render_udvt 🔒

return_description 🔒

source

Render a single Solidity source file as a list of (relative_output_path, mdx_content) pairs.

split_first_word 🔒

strip_one_ws 🔒

write_code_block 🔒

write_comment_block 🔒

write_deployments_table 🔒

Write the Deployments table for a contract page.

write_enum_variants_table 🔒

write_frontmatter 🔒

write_git_source 🔒

Write link if git_url is set.

write_param_table 🔒

write_struct_properties_table 🔒

yaml_escape_double_quoted 🔒

Escape a string for use as a YAML double-quoted scalar.