Skip to content

docs: update theme sections and add install instructions #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oprypin merged 1 commit into from
Mar 18, 2026
Merged

docs: update theme sections and add install instructions #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/user-guide/choosing-your-theme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ Selecting and configuring a theme.

---

ProperDocs includes two built-in themes ([mkdocs](#mkdocs) and
[readthedocs](#readthedocs)), as documented below. However, many [third party
themes] are available to choose from as well.
ProperDocs includes two official themes ([mkdocs](#mkdocs) and [readthedocs](#readthedocs)), as documented below. Many [third party themes] are available to choose from as well.

To choose a theme, set the [theme] configuration option in your `properdocs.yml`
config file.
Expand All @@ -18,8 +16,13 @@ theme:

## mkdocs

The default theme, which was built as a custom [Bootstrap] theme, supports almost
every feature of ProperDocs.
The `mkdocs` theme is the default official theme, built as a custom [Bootstrap] theme, and supports almost every feature of ProperDocs.

Which can be installed with pip:

```bash
pip install properdocs-theme-mkdocs
```

<div id="mkdocs-theme-images" class="carousel slide carousel-fade" data-bs-ride="carousel">
<div class="carousel-inner">
Expand Down Expand Up @@ -132,9 +135,13 @@ supports the following options:

## readthedocs

A clone of the default theme used by the [Read the Docs] service, which offers
the same restricted feature set as its parent theme. Like its parent theme, only
two levels of navigation are supported.
A clone of the default theme used by the [Read the Docs] service, which offers the same restricted feature set as its parent theme. Like its parent theme, only two levels of navigation are supported.

Which can be installed with pip:

```bash
pip install properdocs-theme-readthedocs
```

![ReadTheDocs](../img/readthedocs.png)

Expand Down
Loading