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
1 change: 0 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
version: '3'
services:
ubuntu:
image: ntno/ubuntu-build-base:1.0.0
Expand Down
44 changes: 44 additions & 0 deletions documentation/docs/configuration/palettes/blueberry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

--8<--
configuration/palettes/links.md
--8<--

# Blueberry Palette

To use the dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:

```yaml
theme:
name: terminal
palette: blueberry
```

<link href="../../../css/palettes/blueberry.css" rel="stylesheet">

--8<--
elements/examples/index.md
--8<--

## Tile Grid Example
{{ tile_grid(page.meta) }}

<br>
49 changes: 42 additions & 7 deletions documentation/docs/configuration/palettes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ tiles:
tooltip: to Default Demo Page
alt_text: Default Demo Page
link_href: ./default/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Blueberry palette description." href="#fn:2">Blueberry</a>
img_src: ../../img/palettes/blueberry.png
tooltip: to Blueberry Demo Page
alt_text: Blueberry Demo Page
link_href: ./blueberry/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Gruvbox Dark palette description." href="#fn:2">Gruvbox Dark</a>
img_src: ../../img/palettes/gruvbox_dark.png
tooltip: to Gruvbox Dark Demo Page
Expand All @@ -15,12 +20,22 @@ tiles:
img_src: ../../img/palettes/dark.png
tooltip: to Dark Demo Page
alt_text: Dark Demo Page
link_href: ./dark/
link_href: ./dark/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Lightyear palette description." href="#fn:2">Lightyear</a>
img_src: ../../img/palettes/lightyear.png
tooltip: to Lightyear Demo Page
alt_text: Lightyear Demo Page
link_href: ./lightyear/
- caption: <a id="fnref:4" class="footnote-ref" title="to image description" alt="to Pink palette description." href="#fn:4">Pink</a>
img_src: ../../img/palettes/pink.png
tooltip: to Pink Demo Page
alt_text: Pink Demo Page
link_href: ./pink/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Red Drum palette description." href="#fn:2">Red Drum</a>
img_src: ../../img/palettes/red_drum.png
tooltip: to Red Drum Demo Page
alt_text: Red Drum Demo Page
link_href: ./red_drum/
- caption: <a id="fnref:5" class="footnote-ref" title="to image description" alt="to Sans palette description." href="#fn:5">Sans</a>
img_src: ../../img/palettes/sans.png
tooltip: to Sans Demo Page
Expand All @@ -30,18 +45,33 @@ tiles:
img_src: ../../img/palettes/sans_dark.png
tooltip: to Sans Dark Demo Page
alt_text: Sans Dark Demo Page
link_href: ./sans-dark/
link_href: ./sans-dark/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Soundside palette description." href="#fn:2">Soundside</a>
img_src: ../../img/palettes/soundside.png
tooltip: to Soundside Demo Page
alt_text: Soundside Demo Page
link_href: ./soundside/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Volans palette description." href="#fn:2">Volans</a>
img_src: ../../img/palettes/volans.png
tooltip: to Volans Demo Page
alt_text: Volans Demo Page
link_href: ./volans/
---

# Theme Color Palettes
Terminal for MkDocs supports the following color palettes by default:

- [default](default.md)
- [blueberry](blueberry.md)
- [gruvbox_dark](gruvbox-dark.md)
- [dark](dark.md)
- [lightyear](lightyear.md)
- [pink](pink.md)
- [red_drum](red_drum.md)
- [sans](sans.md)
- [sans_dark](sans-dark.md)
- [soundside](soundside.md)
- [volans](volans.md)

To change the color palette to one of the built in color palettes, add the `palette` attribute to your theme configuration in `mkdocs.yml`:

Expand All @@ -52,8 +82,13 @@ theme:
```

[^1]: white background and light blue hyperlinks.
[^2]: dark grey background, orange hyperlinks, and light yellow text.
[^3]: black background, light blue hyperlinks, and white text.
[^4]: white background and pink hyperlinks.
[^5]: white background, light blue hyperlinks, and sans font.
[^6]: black background, light blue hyperlinks, and white text in sans font.
[^2]: cream background and navy blue hyperlinks
[^3]: dark grey background, orange hyperlinks, and light yellow text.
[^4]: black background, light blue hyperlinks, and white text.
[^5]: hint of green background and pigment indigo hyperlinks
[^6]: white background and pink hyperlinks.
[^7]: double colonial white background and red berry hyperlinks.
[^8]: white background, light blue hyperlinks, and sans font.
[^9]: black background, light blue hyperlinks, and white text in sans font.
[^10]: peach background and sherpa blue hyperlinks.
[^11]: beige background and millbrook hyperlinks.
44 changes: 44 additions & 0 deletions documentation/docs/configuration/palettes/lightyear.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

--8<--
configuration/palettes/links.md
--8<--

# Lightyear Palette

To use the dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:

```yaml
theme:
name: terminal
palette: lightyear
```

<link href="../../../css/palettes/lightyear.css" rel="stylesheet">

--8<--
elements/examples/index.md
--8<--

## Tile Grid Example
{{ tile_grid(page.meta) }}

<br>
7 changes: 6 additions & 1 deletion documentation/docs/configuration/palettes/links.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
<nav class="terminal-mkdocs-pad-to-match-side-nav" markdown>
[Default](default.md) |
[Blueberry](blueberry.md) |
[Gruvbox Dark](gruvbox-dark.md) |
[Dark](dark.md) |
[Lightyear](lightyear.md) |
[Pink](pink.md) |
[Red Drum](red_drum.md) |
[Sans](sans.md) |
[Sans Dark](sans-dark.md)
[Sans Dark](sans-dark.md) |
[Soundside](soundside.md) |
[Volans](volans.md)
</nav>
44 changes: 44 additions & 0 deletions documentation/docs/configuration/palettes/red_drum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

--8<--
configuration/palettes/links.md
--8<--

# Red Drum Palette

To use the dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:

```yaml
theme:
name: terminal
palette: red_drum
```

<link href="../../../css/palettes/red_drum.css" rel="stylesheet">

--8<--
elements/examples/index.md
--8<--

## Tile Grid Example
{{ tile_grid(page.meta) }}

<br>
44 changes: 44 additions & 0 deletions documentation/docs/configuration/palettes/soundside.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

--8<--
configuration/palettes/links.md
--8<--

# Soundside Palette

To use the dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:

```yaml
theme:
name: terminal
palette: soundside
```

<link href="../../../css/palettes/soundside.css" rel="stylesheet">

--8<--
elements/examples/index.md
--8<--

## Tile Grid Example
{{ tile_grid(page.meta) }}

<br>
44 changes: 44 additions & 0 deletions documentation/docs/configuration/palettes/volans.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

--8<--
configuration/palettes/links.md
--8<--

# Volans Palette

To use the dark color palette, add the `palette` attribute to your theme configuration in `mkdocs.yml`:

```yaml
theme:
name: terminal
palette: volans
```

<link href="../../../css/palettes/volans.css" rel="stylesheet">

--8<--
elements/examples/index.md
--8<--

## Tile Grid Example
{{ tile_grid(page.meta) }}

<br>
Binary file added documentation/docs/img/palettes/blueberry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/img/palettes/lightyear.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/img/palettes/red_drum.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/img/palettes/soundside.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/docs/img/palettes/volans.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ nav:
- Color Palettes:
- Index: 'configuration/palettes/index.md'
- Default: 'configuration/palettes/default.md'
- Blueberry: 'configuration/palettes/blueberry.md'
- Gruvbox Dark: 'configuration/palettes/gruvbox-dark.md'
- Dark: 'configuration/palettes/dark.md'
- Lightyear: 'configuration/palettes/lightyear.md'
- Pink: 'configuration/palettes/pink.md'
- Red Drum: 'configuration/palettes/red_drum.md'
- Sans: 'configuration/palettes/sans.md'
- Sans Dark: 'configuration/palettes/sans-dark.md'
- Soundside: 'configuration/palettes/soundside.md'
- Volans: 'configuration/palettes/volans.md'
- Features: 'configuration/features.md'
- Blocks: 'configuration/blocks.md'
- Plugins: 'configuration/plugins/index.md'
Expand Down Expand Up @@ -91,13 +96,19 @@ plugins:
- configuration/palettes/pink.md#pink-palette
- configuration/palettes/sans-dark.md#sans-dark-palette
- configuration/palettes/sans.md#sans-palette
- configuration/palettes/blueberry.md#blueberry-palette
- configuration/palettes/lightyear.md#lightyear-palette
- configuration/palettes/red_drum.md#red_drum-palette
- configuration/palettes/soundside.md#soundside-palette
- configuration/palettes/volans.md#volans-palette
- macros:
modules:
- mkdocs-terminal:terminal.pluglets.tile_grid.main

## deploy settings
theme:
name: terminal
palette: default
custom_dir: theme_overrides
features:
- footer.prev_next
Expand Down
Loading
Loading