Skip to content

API Reference page title has large space before it #399

@has2k1

Description

@has2k1

Currently, the rendering of the API Reference / Index page is completed in the Blueprint. This part puts together the title and the rest of the page content; and a Renderer cannot affect this markup.

_log.info("Summarizing docs for index page.")
content = self.renderer.summarize(blueprint)
_log.info(f"Writing index to directory: {self.dir}")
final = str(
Blocks([Header(1, self.title, Attr(classes=["doc", "doc-index"])), content])
)

As a result, in qrenderer we cannot generate the right markup to avoid that different way quarto handles a title specified in the yaml frontmatter verses one that is derived from the top-level (#) header.

We can see the effect in these two pages.

quartodoc:
Image

quarto:
Image

Ref: #320 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions