Skip to content

Commit 9e77aaf

Browse files
authored
Add extra configs to the myst site (#17)
Add authors, description, subject and keywords to `myst.yml`. Include SimPEG logo in the navbar, and add some navbar links to SimPEG website and documentation pages. Exclude the `README.md` file in the built website.
1 parent 07bd211 commit 9e77aaf

File tree

2 files changed

+25
-7
lines changed

2 files changed

+25
-7
lines changed

images/simpeg-logo.png

23 KB
Loading

myst.yml

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,24 @@
22
version: 1
33
project:
44
title: SimPEG User Tutorials
5+
subject: SimPEG User Tutorials
6+
description: SimPEG user tutorials
57
license:
68
content: CC-BY-4.0
79
code: MIT
8-
# github:
9-
# description:
10-
keywords: []
11-
authors: []
1210
github: https://github.com/simpeg/user-tutorials
11+
keywords:
12+
- geophysics
13+
- inversions
14+
- python
15+
- open-source
16+
authors:
17+
- name: Devin Cowan
18+
affiliations:
19+
- University of British Columbia
20+
- name: Santiago Soler
21+
affiliations:
22+
- University of British Columbia
1323
# bibliography: []
1424
references:
1525
python: https://docs.python.org/3/
@@ -20,16 +30,24 @@ project:
2030
SimPEG: https://docs.simpeg.xyz/
2131
geoana: https://geoana.simpeg.xyz/
2232
sphinx: https://www.sphinx-doc.org/en/master/
33+
exclude:
34+
- README.md
2335
site:
2436
template: book-theme
2537
title: SimPEG User Tutorials
2638
thumbnail: https://raw.github.com/simpeg/simpeg/main/docs/images/simpeg-logo.png
27-
# logo:
28-
nav: []
39+
nav:
40+
- title: SimPEG
41+
children:
42+
- title: Project website
43+
url: https://simpeg.xyz
44+
- title: Documentation
45+
url: https://docs.simpeg.xyz
2946
actions:
3047
- title: Learn More
3148
url: https://mystmd.org/guide
3249
domains: []
33-
# Add Plausible analytics
3450
options:
3551
analytics_plausible: simpeg.xyz
52+
logo: images/simpeg-logo.png
53+
logo_text: User Tutorials

0 commit comments

Comments
 (0)