Skip to content
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.

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

issue #6 & link colors #7

Merged
merged 1 commit into from
Dec 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ This extension applies styling changes, being
- buttons,
- badges,
- custom components,
- $\LaTeX$
- $\LaTeX$,
- the primary and secondary color of the book (mainly used for typesetting links).
- particular icons for:
- proofs (e.g. theorem, axiom, lemma, corollary, etc.),
- exercises,
Expand Down Expand Up @@ -54,9 +55,23 @@ In your `_config.yml` file, add the extension to the list of Sphinx extra extens
```
sphinx:
extra_extensions:
.
.
.
- sphinx_tudelft_theme
.
.
.
```

The following Sphinx extra extensions (if used) must be added _before_ this extension:

- `sphinx_proof`
- `sphinx_exercise`
- `teachbooks_sphinx_grasple`

If this is forgotten, the CSS of this extension cannot be applied correctly.

## Usage

By following the steps above, the theme will be applied automatically. To see the examples of usage visit the [TeachBooks manual](https://teachbooks.io/manual/intro.html).
Expand Down
5 changes: 5 additions & 0 deletions src/sphinx_tudelft_theme/static/tudelft_style.css
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@
--darkBlue-min: #c1e3ff10;
--darkBlue-mid: #c1e3ff25;
}

html {
--pst-color-primary: var(--cyan) !important;
--pst-color-secondary: var(--green) !important;
}

/* BLOCK COMPONENTS (admonitions, proofs, exercises) */

Expand Down
Loading