Add Addons customization docs #11888
Conversation
This is start for this work, and mostly just pulls examples from the Mkdocs page over to the Addons docs. I think there's more to do here with examples, but I think this is a reasonable starting point.
|
I would not document the CSS variables yet since we are having a discussion about that in readthedocs/addons#473 and we are thinking about removing support for them for now while we explore how to it in a reliable way. |
This reverts commit 755bfff.
This reverts commit a371da0.
|
|
||
| :root { | ||
| /* Reduce Read the Docs' flyout font a little bit */ | ||
| --readthedocs-flyout-font-size: 0.7rem; |
There was a problem hiding this comment.
I left a comment about if users should use rem or px here in readthedocs/addons#488 (comment) because it's not 100% clear to me yet.
| - ``--readthedocs-search-result-section-highlight-color`` | ||
| - ``--readthedocs-search-result-section-subheading-color`` | ||
|
|
||
| You can find default values and full CSS in our `Addons source <https://github.com/readthedocs/addons/tree/main/src>`_. |
There was a problem hiding this comment.
This could be a .. tip:: block.
| - ``--readthedocs-flyout-dd-font-size`` | ||
| - ``--readthedocs-flyout-dt-font-size`` |
There was a problem hiding this comment.
@agjohnson mentioned these dd- where not necessary in readthedocs/addons#488 (comment), so I'm not sure if he is planning to remove them.
| * ``projects.current`` - Current project details | ||
| * ``projects.translations`` - Available translations | ||
| * ``versions.current`` - Details about the current version | ||
| * ``versions.active`` - List of all active versions |
There was a problem hiding this comment.
This is the list of "active, built and not hidden" versions. We can explain that in the paragraph.
| } | ||
| } | ||
|
|
||
| You can see a live example of this in our `Addons API response for these docs <https://docs.readthedocs.io/_/addons/?client-version=0.22.0&api-version=1&project-slug=docs&version-slug=stable>`_. |
This is start for this work,
and mostly just pulls examples from the Mkdocs page over to the Addons docs.
I think there's more to do here with examples,
but I think this is a reasonable starting point.
📚 Documentation previews 📚
docs): https://docs--11888.org.readthedocs.build/en/11888/dev): https://dev--11888.org.readthedocs.build/en/11888/