-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
89 lines (80 loc) · 3.31 KB
/
mkdocs.yml
File metadata and controls
89 lines (80 loc) · 3.31 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# ============================================================
# PORTFOLIO CONFIGURATION
# Edit all lines marked [YOUR ...] to customize your site
# ============================================================
site_name: "[YOUR NAME] - Geospatial Portfolio"
site_description: "Portfolio of [YOUR NAME] — GIS, Remote Sensing, and Spatial Data Science"
site_author: "[YOUR NAME]"
# After your site is live, uncomment and set this to your actual GitHub Pages URL:
# site_url: "https://your-username.github.io/your-repo-name"
theme:
name: material
# Icon used as both the site logo (header) and browser favicon.
# Browse icons at https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/
# and replace "material/earth" with any "material/..." icon name you prefer.
icon:
logo: material/earth
palette:
# To change the color, edit the 'primary' and 'accent' values below for both
# the 'default' (light) and 'slate' (dark) schemes.
# Available colors: red, pink, purple, deep purple, indigo, blue, light blue,
# cyan, teal, green, light green, lime, yellow, amber, orange, deep orange
- scheme: default # Light mode
primary: indigo
accent: blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate # Dark mode
primary: indigo
accent: blue
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs # Top-level nav items shown as horizontal tabs
- navigation.top # Back-to-top button when scrolling up
- content.code.copy # Copy button on all code blocks
font:
text: Roboto
code: Roboto Mono
extra_css:
- assets/css/extra.css
markdown_extensions:
- md_in_html # Allows Markdown inside HTML blocks (used for project cards)
- attr_list # Allows adding CSS classes to elements: { .class }
- admonition # Note/warning/tip boxes
- pymdownx.details # Collapsible admonition blocks
- pymdownx.superfences
- tables
- pymdownx.emoji: # Renders :material-icon: and :fontawesome-brands-icon: inline icons
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
copyright: "Copyright © [YOUR NAME]"
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/[YOUR-GITHUB-USERNAME]
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/in/[YOUR-LINKEDIN-USERNAME]
- icon: material/email
link: mailto:[YOUR-EMAIL-ADDRESS]
plugins:
- search
- meta
- mkdocs-jupyter
nav:
- Home: index.md
- Projects:
- "All Projects": projects/index.md
- "Sample Project": projects/sample-project.md
- "Jupyter Notebook Project": projects/sample-notebook.ipynb
# HOW TO ADD A NEW PROJECT:
# 1. Copy docs/projects/sample-project.md to docs/projects/your-project-name.md
# (or drop an .ipynb file into docs/projects/ for a Jupyter notebook project)
# 2. Edit the new file with your project content
# 3. Add a line below (same format): - "Your Project Title": projects/your-project-name.md
# 4. Add a project card on docs/projects/index.md
- Publications: publications.md
- Experience: experience.md
- Contact: contact.md