Skip to content
Open
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
2 changes: 2 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# SCM syntax highlighting & preventing 3-way merges
pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ site/*

# Mac stuff
.DS_Store
# pixi environments
.pixi/*
!.pixi/config.toml
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ Uses [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme
## To build locally

1. Create a python environment containing the packages in requirements.txt.
We recommend using [mambaforge](https://mamba.readthedocs.io/en/latest/installation.html).
We recommend using [pixi](https://pixi.prefix.dev/latest/)

2. Build the site and start the docs server:

```bash
mkdocs build
mkdocs serve
pixi run properdocs serve -o
```
4 changes: 4 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
[data-md-color-scheme="default"] {
--md-primary-fg-color: #0033A0;
--md-primary-fg-color--light: #0033A0;
--md-primary-fg-color--dark: #0033A0;
--md-code-hl-color: #99C5ff;
}
[data-md-color-scheme="slate"] {
--md-primary-fg-color: #0033A0;
--md-primary-fg-color--light: #0033A0;
--md-primary-fg-color--dark: #0033A0;
--md-typeset-a-color: #4C9AFF;
}
634 changes: 634 additions & 0 deletions pixi.lock

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions pixi.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[workspace]
authors = ["Jenny Fothergill <jennyfothergill@boisestate.edu>"]
channels = ["conda-forge"]
name = "docs"
platforms = ["osx-arm64"]
version = "0.1.0"

[tasks]

[dependencies]
python = ">=3.14.7,<3.15"

[pypi-dependencies]
mkdocs-materialx = ">=10.2.0, <11"
properdocs = ">=1.6.7, <2"
3 changes: 2 additions & 1 deletion mkdocs.yml → properdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,10 @@ theme:
- navigation.instant
- navigation.sections
- toc.integrate
name: material
name: materialx
logo: images/boisestate-B-1color-orange-rgb.png
favicon: images/boisestate-B-1color-orange-rgb.png
topbar_style: primary
palette:
- scheme: default
toggle:
Expand Down
6 changes: 3 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
mkdocs==1.6.1
mkdocs-material==9.7.7
Pygments==2.20.0
properdocs==1.6.7
mkdocs-materialx==9.7.6
Pygments==2.21.0