Skip to content

Commit b5dfb2d

Browse files
authored
Merge pull request #7 from CU-ESIIL/codex/fix-homepage-and-examples-components-in-mkdocs
Fix homepage and examples rendering in standard MkDocs Material setup
2 parents b9b5ab5 + d72ed3e commit b5dfb2d

2 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/examples.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# UI Examples
22

3-
This page contains small, copyable patterns you can reuse across the site.
3+
This page contains small, copyable patterns that are compatible with a standard MkDocs + Material setup.
44

55
## Hoverable button
66

77
Use this for a small call-to-action with a subtle hover effect.
88

9-
<a class="md-button oasis-hover-button" href="#">Example hover button</a>
9+
[Back to Home](index.md){ .md-button .oasis-hover-button }
1010

11-
```html
12-
<a class="md-button oasis-hover-button" href="#">Example hover button</a>
11+
```md
12+
[Back to Home](index.md){ .md-button .oasis-hover-button }
1313
```
1414

1515
## Responsive iframe embed
@@ -18,7 +18,7 @@ Use this wrapper to keep embedded content responsive.
1818

1919
<div class="oasis-embed">
2020
<iframe
21-
title="Example map embed"
21+
title="OpenStreetMap example embed"
2222
src="https://www.openstreetmap.org/export/embed.html?bbox=-105.3%2C39.9%2C-104.9%2C40.1&amp;layer=mapnik"
2323
loading="lazy"
2424
allowfullscreen>
@@ -28,8 +28,8 @@ Use this wrapper to keep embedded content responsive.
2828
```html
2929
<div class="oasis-embed">
3030
<iframe
31-
title="Example embed"
32-
src="https://example.com"
31+
title="OpenStreetMap example embed"
32+
src="https://www.openstreetmap.org/export/embed.html?bbox=-105.3%2C39.9%2C-104.9%2C40.1&amp;layer=mapnik"
3333
loading="lazy"
3434
allowfullscreen>
3535
</iframe>

docs/index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
# basic_OASIS
22

3-
Welcome to `basic_OASIS`, a lightweight documentation starter built with MkDocs + Material. Use this as a clean baseline for project notes, quick guides, and student-facing documentation.
3+
`basic_OASIS` is a lightweight MkDocs + Material starter for clear project documentation. It is designed to stay minimal, readable, and easy to extend.
44

5-
[Get Started](examples.md){ .md-button .md-button--primary }
5+
[Explore Examples](examples.md){ .md-button .md-button--primary }
66
[View Repository](https://github.com/CU-ESIIL/basic_OASIS){ .md-button }
77

88
<div class="grid cards" markdown>
99

10-
- :material-code-tags: **Code**
10+
- **Code**
1111

1212
---
1313

14-
Keep setup steps, scripts, and reproducible snippets in one place.
14+
Capture setup steps, scripts, and reproducible snippets in one place.
1515

16-
- :material-database: **Data**
16+
- **Data**
1717

1818
---
1919

20-
Share data access notes, schemas, and provenance details clearly.
20+
Document data access, formats, and provenance so work stays transparent.
2121

22-
- :material-file-document-outline: **Docs**
22+
- **Docs**
2323

2424
---
2525

26-
Build concise guides that are easy to maintain and extend over time.
26+
Write concise guides that future contributors can quickly understand.
2727

2828
</div>
2929

3030
!!! note "Template-first by design"
31-
This site is intentionally minimal. Treat it as a starter template and extend only what your project needs.
31+
This site is intentionally minimal. Start simple, then extend only what your project needs.

0 commit comments

Comments
 (0)