Skip to content

Customization options to replicate Quarto appearance #328

Description

@cliffckerr

We currently have 20-30 docsets written using Quarto + quartodoc, e.g. Sciris and Starsim, or Material for MkDocs, e.g. History Matching.

What's currently blocking us from migrating to Great Docs is the ability to keep the current styling (at least for the Quarto sites, which we spent a lot of time on the aesthetics of). Since Great Docs creates a _quarto.yml and then uses Quarto for render, this should be technically feasible: keep the Great Docs configs, but provide a pass-through mechanism to allow for arbitrary customization of the resultant _quarto.yml.

This feature proposal consists of:

  • Provide a pass-through option for users who know exactly what they want (parts of) their `_quarto.yaml to look like;
  • More configurability for the API reference (at minimum, being able to replicate the quartodoc layout);
  • Scripts and/or agent skills to migrate a project from a Quarto docs build to a Great Docs build.

Stretch goals would be to also migrate from Material for MkDocs and Sphinx, but that (especially the latter) is a pretty substantial project and probably deserves an issue of its own!

I can try to put together a prototype of this feature in the next ~month or so on my fork and make a PR. Feel free to ping me if you can get to this first!

(As discussed today -- thanks @rich-iannone!)

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions