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

enh: doc theme #16

Merged
merged 1 commit into from
May 16, 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
4 changes: 2 additions & 2 deletions .github/workflows/deploy_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ jobs:
- name: Install requirements
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-techdocs-core pymdown-extensions mkdocs_monorepo_plugin
pip install mkdocs pymdown-extensions termynal mkdocs-material
- name: Deploying MkDocs documentation
run: |
mkdocs build
mkdocs gh-deploy --force
mkdocs gh-deploy --force
11 changes: 11 additions & 0 deletions docs/images/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions docs/images/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
73 changes: 73 additions & 0 deletions docs/stylesheets/skaff.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
/* https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#custom-colors */
:root {
--md-primary-fg-color: #142146;
--md-accent-fg-color: #fc2c7f;
}

/* Revert hue value to that of pre mkdocs-material v9.4.0 */
[data-md-color-scheme="slate"] {
/* Hue taken from hsl of #142146, used for bg on website*/
--md-hue: 227;
/* Increase the lightness by 5%, opacity by 0.2 */
--md-default-fg-color: hsla(var(--md-hue),15%,95%,1.0);
--md-default-fg-color--light: hsla(var(--md-hue),15%,95%,0.76);
--md-default-fg-color--lighter: hsla(var(--md-hue),15%,95%,0.52);
--md-default-fg-color--lightest: hsla(var(--md-hue),15%,95%,0.32);
/* Change the saturation and lightness to match #142146 */
--md-default-bg-color: hsla(var(--md-hue),87%,6%,1);
--md-default-bg-color--light: hsla(var(--md-hue),87%,6%,0.54);
--md-default-bg-color--lighter: hsla(var(--md-hue),87%,6%,0.26);
--md-default-bg-color--lightest: hsla(var(--md-hue),87%,6%,0.07);
/* Increase the opacity of code to 1.0 */
--md-code-fg-color: hsla(var(--md-hue),18%,86%,1.0);
--md-code-hl-comment-color: #666666;
--md-typeset-a-color: #65cccc;
}

[data-md-color-scheme="default"] {
--md-hue: 227;
--md-default-bg-color: hsla(var(--md-hue),100%,96%,1);
--md-typeset-a-color: #65cccc;

--md-code-fg-color: hsla(var(--md-hue),18%,86%,1.0);
--md-code-bg-color: #262a32;
--md-code-hl-name-color: var(--md-code-fg-color);
--md-code-hl-operator-color: var(--md-code-fg-color);
--md-code-hl-punctuation-color: var(--md-code-fg-color);
--md-code-hl-comment-color: #666666;
--md-code-hl-variable-color: var(--md-code-fg-color);
}

.custom-source-wrapper {
display: flex;
justify-content: space-between;
align-items: center;
gap: 12px;
}

@media screen and (min-width: 60em) {
.md-header__source {
box-sizing: content-box;
max-width: 11.7rem;
width: 11.7rem;
}
}

.custom-login-button {
font-size: 0.8rem;
font-weight: 700;
float: right;
border: 2px solid #fff;
border-radius: 8px;
padding: 6px 12px;
transition: opacity .25s;
}

.custom-login-button:hover {
opacity: 0.7
}

/* Hide all ToC entries for parameters. */
li.md-nav__item>a[href*="("] {
display: none;
}
108 changes: 0 additions & 108 deletions examples/load_documents.ipynb

This file was deleted.

Loading
Loading