himeno/mopress/summary does not have a README file

    ArticleIndex

    pub(all) struct ArticleIndex {
    title : String
    location : String
    content : String
    } derive(Eq,
    Debug
    ,
    ToJson
    )

    A single article's indexed content, e.g. for building a client-side search index over the site's pages.

    ArticleIndex::equal

    ArticleIndex::not_equal

    fn ArticleIndex::not_equal(x : ArticleIndex, y : ArticleIndex) -> Bool

    PageMeta

    pub(all) struct PageMeta {
    title : String
    location : String
    description : String?
    keywords : String?
    authors : String?
    language : String?
    date : String?
    } derive(Eq,
    Debug
    )

    Per-page metadata collected from a Summary plus each source file's frontmatter, used for feed and sitemap generation.

    Every frontmatter field is optional: missing values are either omitted from the generated output or fall back to site-level config. The recognized fields are description, keywords, authors, language and date; title is taken from the summary link's own title.

    PageMeta::equal

    fn PageMeta::equal(PageMeta, PageMeta) -> Bool

    PageMeta::not_equal

    fn PageMeta::not_equal(x : PageMeta, y : PageMeta) -> Bool

    PageMeta::to_repr

    Summary

    pub(all) struct Summary {
    title : String
    prefix_chapters : Array[SummaryItem]
    numbered_chapters : Array[SummaryItem]
    suffix_chapters : Array[SummaryItem]
    ordered_items : Array[SummarySectionItem]
    } derive(Eq,
    Debug
    )

    The parsed structure of a book's table of contents (SUMMARY.md), split into an optional prefix section, the main numbered chapters, and an optional suffix section — mirroring the conventional structure of an mdBook-style summary file.

    Summary::breadcrumb

    fn Summary::breadcrumb(self : Summary, current : String) -> String

    Returns a breadcrumb string describing the path from the root of the table of contents down to the chapter located at location.

    Summary::collect_page_meta

    fn Summary::collect_page_meta(self : Summary, src : String) -> Array[PageMeta] raise

    Collects per-page metadata for every link reachable from this summary, reading each article's source file under src to extract frontmatter fields.

    Raises if any referenced source file cannot be read.

    Summary::equal

    fn Summary::equal(Summary, Summary) -> Bool

    Summary::flatten

    fn Summary::flatten(self : Summary, current : String, base_url : String) ->
    Json

    Returns a JSON representation of this summary, rooted at location, e.g. for use as a template variable describing the current section's navigation structure.

    Summary::index_articles

    fn Summary::index_articles(self : Summary, src : String) -> Array[ArticleIndex] raise

    Builds a search/content index over all articles reachable from this summary, reading each article's source file from src.

    Raises if any referenced article's source file cannot be read.

    Summary::not_equal

    fn Summary::not_equal(x : Summary, y : Summary) -> Bool

    Summary::prev_next

    fn Summary::prev_next(self : Summary, current : String) -> ((String, String)?, (String, String)?)

    Returns the previous and next chapter (as (title, location) pairs), relative to the chapter located at location, according to this summary's chapter ordering. Either value is None if there is no previous/next chapter (e.g. at the start or end of the book).

    Summary::to_repr

    SummaryItem

    pub(all) enum SummaryItem {
    Link(SummaryLink)
    PartTitle(String)
    Separator
    } derive(Eq,
    Debug
    )

    A single entry in a table of contents.

    SummaryItem::equal

    fn SummaryItem::equal(SummaryItem, SummaryItem) -> Bool

    SummaryItem::not_equal

    fn SummaryItem::not_equal(x : SummaryItem, y : SummaryItem) -> Bool

    pub(all) struct SummaryLink {
    title : String
    location : String
    source : String
    nested_items : Array[SummaryItem]
    } derive(Eq,
    Debug
    )

    A single chapter link in a table of contents.

    SummaryLink::equal

    fn SummaryLink::equal(SummaryLink, SummaryLink) -> Bool

    SummaryLink::not_equal

    fn SummaryLink::not_equal(x : SummaryLink, y : SummaryLink) -> Bool

    SummarySectionItem

    pub(all) struct SummarySectionItem {
    item : SummaryItem
    numbered : Bool
    } derive(Eq,
    Debug
    )

    SummarySectionItem::equal

    SummarySectionItem::not_equal

    generate_feed_xml

    fn generate_feed_xml(config :
    BookConfig
    , metas : Array[PageMeta], build_time : String) -> String

    Renders an Atom feed for the given pages.

    Returns an empty string when config.site_url is unset, since Atom requires absolute entry URLs and the site has no way to construct them.

    build_time (a YYYY/MM/DD HH:MM:SS string) is used as the feed-level <updated> timestamp and as the fallback for entries whose source file has no date frontmatter field.

    generate_robots_txt

    fn generate_robots_txt(sitemap_url? : String?, allow? : Array[String], disallow? : Array[String]) -> String

    Renders standard robots.txt content, optionally including a reference to the site's sitemap.xml.

    generate_sitemap_xml

    fn generate_sitemap_xml(config :
    BookConfig
    , metas : Array[PageMeta]) -> String

    Renders a sitemap for the given pages, using absolute URLs when config.site_url is set and base_url-relative URLs otherwise.

    md_to_plain

    fn md_to_plain(input : String) -> String

    Renders a Markdown string to its plain-text representation (stripping all Markdown/HTML markup), e.g. for use in generating search indexes or previews from summary/article content.

    parse_summary

    Parses a book's SUMMARY.md (already parsed into a Markdown AST) into its structured Summary representation.

    Source Files