Module docs 

Exposes the docs module.

Examples

use pharos_runtime_docs::docs;

Related

• crate for sibling modules in the same crate.

Structs

DocsNavEntry

Public struct DocsNavEntry used by this module.

DocsNavNode 🔒

DocsOutputRemap

Public struct DocsOutputRemap used by this module.

Constants

MAX_DOC_FILES 🔒

MAX_DOC_TEXT_BYTES 🔒

Functions

CLOSE_LIST

Performs CLOSE LIST.

FLUSH_PARA

Flushes one markdown paragraph into the output buffer.

append_docs_text 🔒

Appends one required docs fragment and converts failure into a render failure.

append_inline_markup

Appends a bounded inline-markup fragment with safe link and code handling.

append_inline_markup_for_page 🔒

Renders inline Markdown while rewriting local links for one output page.

close_docs_list 🔒

Closes an open Markdown list.

collect_md_files

Collects md files.

dbuf_append

Appends one raw buffer fragment within the documentation size limit.

dbuf_append_html_escaped

Appends escaped HTML text to a documentation buffer.

dbuf_detach

Transfers the buffer contents, leaving an unallocated empty buffer.

dbuf_ensure

Ensures bounded capacity for one raw buffer append.

dbuf_free

Performs dbuf free.

dbuf_init

Resets a documentation buffer and releases its previous allocation.

dbuf_put_anchor_open

Performs dbuf put anchor open.

dbuf_put_tag_close

Closes a validated markup tag.

dbuf_put_tag_open

Performs dbuf put tag open.

dbuf_putc

Appends one escaped character to a documentation buffer.

dbuf_puts

Appends one NUL-terminated C-string equivalent to the buffer.

docs_default_html_output_rel 🔒

Performs docs default HTML output rel.

docs_html_output_rel

Performs docs HTML output rel.

docs_html_output_rel_with_remap

Performs docs HTML output rel with remap.

docs_markdown_to_html

Performs docs markdown to HTML.

docs_markdown_to_html_with_remap

Performs docs markdown to HTML with remap.

docs_markdown_to_html_with_remap_for_page

Converts the supported Markdown and authored HTML mixture used by Pharos docs.

docs_nav_collect_entries_local

Performs docs nav collect entries local.

docs_nav_default_open 🔒

docs_nav_node_contains_current 🔒

docs_nav_parse_nodes 🔒

docs_nav_tree 🔒

docs_output_remap_append

Performs docs output remap append.

docs_output_remap_clear

Performs docs output remap clear.

docs_output_remap_finish_item

Completes one output remap item only when both sides are present.

docs_output_remap_load_json_array

Performs docs output remap load JSON array.

docs_output_remap_load_yaml

Performs docs output remap load YAML.

docs_output_remap_lookup_default_html

Performs docs output remap lookup default HTML.

docs_output_remap_lookup_source

Performs docs output remap lookup source.

docs_page_depth

Performs docs page depth.

docs_page_title

Performs docs page title.

docs_relative_prefix

Performs docs relative prefix.

docs_render_page

Performs docs render page.

docs_render_sidebar

Performs docs render sidebar.

docs_render_sidebar_node 🔒

docs_root_href

Performs docs root href.

docs_sidebar_href 🔒

docs_yaml_value

Converts a bounded YAML scalar value into its canonical text representation.

flush_docs_paragraph 🔒

Flushes one paragraph through the page-aware inline renderer.

html_escape 🔒

Performs HTML escape.

line_len

Performs line len.

line_starts_with

Performs line starts with.

markdown_heading 🔒

Extracts a Markdown heading level and its title from one source line.

markdown_list_item 🔒

Extracts one supported unordered or ordered Markdown list item.

relative_href_from_output 🔒

Builds the relative href from output.

render_template_value 🔒

Renders template value.

replace_placeholder

Performs replace placeholder.

resolve_docs_relative_target 🔒

Resolves docs relative target.

rewrite_docs_html_targets 🔒

Rewrites local HTML attribute targets relative to a generated docs page.

rewrite_docs_target 🔒

Rewrites one safe local docs link or asset target.

rewrite_link_target

Rewrites one documentation link target while rejecting unsafe schemes.

skip_spaces

Performs skip spaces.