Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there a sidebar in this theme? #44

Merged
merged 6 commits into from
Jan 28, 2025
Merged
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: 1 addition & 1 deletion LAST_VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.0.9
0.0.10
10 changes: 6 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Home

January 1, 2025

---

Expand All @@ -20,23 +22,23 @@ docs/
... # Other markdown pages, images and other files.
```

### Installation MkDocs
## Installation MkDocs

To install MkDocs, run the following command from the command line:

```bash
pip install mkdocs
```

### Installation theme
## Installation theme

Install the theme using PIP:

```bash
pip install mkdocs-simple-blog
```

### Activating theme
## Activating theme

After the theme is installed, edit your `mkdocs.yml` file and set the theme name to `simple-blog`:

Expand Down
4 changes: 3 additions & 1 deletion docs/nav/development/development-guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Last updated January 1, 2025
# Development guide

Last updated January 28, 2024

---

Expand Down
4 changes: 3 additions & 1 deletion docs/nav/development/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Release

March 25, 2023

---

Expand Down
10 changes: 5 additions & 5 deletions docs/nav/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Getting Started

March 25, 2023

---

## Install

### Installation MkDocs
## Installation MkDocs

To install MkDocs, run the following command from the command line:

```bash
pip install mkdocs
```

### Installation theme
## Installation theme

Install the theme using PIP:

```bash
pip install mkdocs-simple-blog
```

### Activating theme
## Activating theme

After the theme is installed, edit your `mkdocs.yml` file and set the theme name to `simple-blog`:

Expand Down
70 changes: 36 additions & 34 deletions docs/nav/styles/colors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Colors

January 17, 2023

---

Expand All @@ -14,7 +16,7 @@ theme:
```

<button class="color-button" data-theme="light">
<code style="background: #ffffff; color: #000000 !important">light</code>
<code style="background: #ffffff !important; color: #000000 !important">light</code>
</button>
<button class="color-button" data-theme="dark">
<code style="background: #000000; color: #ffffff !important">dark</code>
Expand All @@ -31,28 +33,28 @@ theme:
```

<button color-primary="#000000">
<code style="background: var(--color-black); color: #ffffff !important;">black</code>
<code style="background: var(--color-black) !important; color: #ffffff !important;">black</code>
</button>
<button color-primary="#4051b5">
<code style="background: var(--color-blue); color: #ffffff !important;">blue</code>
<code style="background: var(--color-blue) !important; color: #ffffff !important;">blue</code>
</button>
<button color-primary="#4cae4f">
<code style="background: var(--color-green); color: #ffffff !important;">green</code>
<code style="background: var(--color-green) !important; color: #ffffff !important;">green</code>
</button>
<button color-primary="#f1dc15">
<code style="background: var(--color-yellow); color: #000000 !important;">yellow</code>
<code style="background: var(--color-yellow) !important; color: #000000 !important;">yellow</code>
</button>
<button color-primary="#ffa724">
<code style="background: var(--color-orange); color: #000000 !important;">orange</code>
<code style="background: var(--color-orange) !important; color: #000000 !important;">orange</code>
</button>
<button color-primary="#ab47bd">
<code style="background: var(--color-purple); color: #ffffff !important;">purple</code>
<code style="background: var(--color-purple) !important; color: #ffffff !important;">purple</code>
</button>
<button color-primary="#ff2c06">
<code style="background: var(--color-red); color: #ffffff !important;">red</code>
<code style="background: var(--color-red) !important; color: #ffffff !important;">red</code>
</button>
<button color-primary="#ffffff">
<code style="background: var(--color-white); color: #000000 !important;">white</code>
<code style="background: var(--color-white) !important; color: #000000 !important;">white</code>
</button>

### Text color
Expand All @@ -66,28 +68,28 @@ theme:
```

<button color-text="#000000">
<code style="background: var(--color-white); color: var(--color-black) !important;">black</code>
<code style="background: var(--color-white) !important; color: var(--color-black) !important;">black</code>
</button>
<button color-text="#4051b5">
<code style="background: var(--color-white); color: var(--color-blue) !important;">blue</code>
<code style="background: var(--color-white) !important; color: var(--color-blue) !important;">blue</code>
</button>
<button color-text="#4cae4f">
<code style="background: var(--color-white); color: var(--color-green) !important;">green</code>
<code style="background: var(--color-white) !important; color: var(--color-green) !important;">green</code>
</button>
<button color-text="#f1dc15">
<code style="background: var(--color-white); color: var(--color-yellow) !important;">yellow</code>
<code style="background: var(--color-white) !important; color: var(--color-yellow) !important;">yellow</code>
</button>
<button color-text="#ffa724">
<code style="background: var(--color-white); color: var(--color-orange) !important;">orange</code>
<code style="background: var(--color-white) !important; color: var(--color-orange) !important;">orange</code>
</button>
<button color-text="#ab47bd">
<code style="background: var(--color-white); color: var(--color-purple) !important;">purple</code>
<code style="background: var(--color-white) !important; color: var(--color-purple) !important;">purple</code>
</button>
<button color-text="#ff2c06">
<code style="background: var(--color-white); color: var(--color-red) !important;">red</code>
<code style="background: var(--color-white) !important; color: var(--color-red) !important;">red</code>
</button>
<button color-text="#ffffff">
<code style="background: var(--color-white); color: #000000 !important;">white</code>
<code style="background: var(--color-white) !important; color: #000000 !important;">white</code>
</button>

### Title color
Expand All @@ -101,28 +103,28 @@ theme:
```

<button color-title="#000000">
<code style="background: var(--color-white); color: var(--color-black) !important;">black</code>
<code style="background: var(--color-white) !important; color: var(--color-black) !important;">black</code>
</button>
<button color-title="#4051b5">
<code style="background: var(--color-white); color: var(--color-blue) !important;">blue</code>
<code style="background: var(--color-white) !important; color: var(--color-blue) !important;">blue</code>
</button>
<button color-title="#4cae4f">
<code style="background: var(--color-white); color: var(--color-green) !important;">green</code>
<code style="background: var(--color-white) !important; color: var(--color-green) !important;">green</code>
</button>
<button color-title="#f1dc15">
<code style="background: var(--color-white); color: var(--color-yellow) !important;">yellow</code>
<code style="background: var(--color-white) !important; color: var(--color-yellow) !important;">yellow</code>
</button>
<button color-title="#ffa724">
<code style="background: var(--color-white); color: var(--color-orange) !important;">orange</code>
<code style="background: var(--color-white) !important; color: var(--color-orange) !important;">orange</code>
</button>
<button color-title="#ab47bd">
<code style="background: var(--color-white); color: var(--color-purple) !important;">purple</code>
<code style="background: var(--color-white) !important; color: var(--color-purple) !important;">purple</code>
</button>
<button color-title="#ff2c06">
<code style="background: var(--color-white); color: var(--color-red) !important;">red</code>
<code style="background: var(--color-white) !important; color: var(--color-red) !important;">red</code>
</button>
<button color-title="#ffffff">
<code style="background: var(--color-white); color: #000000 !important;">white</code>
<code style="background: var(--color-white) !important; color: #000000 !important;">white</code>
</button>

### Background color
Expand All @@ -136,26 +138,26 @@ theme:
```

<button color-background="#000000">
<code style="background: var(--color-black); color: #ffffff !important;">black</code>
<code style="background: var(--color-black) !important; color: #ffffff !important;">black</code>
</button>
<button color-background="#4051b5">
<code style="background: var(--color-blue); color: #ffffff !important;">blue</code>
<code style="background: var(--color-blue) !important; color: #ffffff !important;">blue</code>
</button>
<button color-background="#4cae4f">
<code style="background: var(--color-green); color: #ffffff !important;">green</code>
<code style="background: var(--color-green) !important; color: #ffffff !important;">green</code>
</button>
<button color-background="#f1dc15">
<code style="background: var(--color-yellow); color: #000000 !important;">yellow</code>
<code style="background: var(--color-yellow) !important; color: #000000 !important;">yellow</code>
</button>
<button color-background="#ffa724">
<code style="background: var(--color-orange); color: #000000 !important;">orange</code>
<code style="background: var(--color-orange) !important; color: #000000 !important;">orange</code>
</button>
<button color-background="#ab47bd">
<code style="background: var(--color-purple); color: #ffffff !important;">purple</code>
<code style="background: var(--color-purple) !important; color: #ffffff !important;">purple</code>
</button>
<button color-background="#ff2c06">
<code style="background: var(--color-red); color: #ffffff !important;">red</code>
<code style="background: var(--color-red) !important; color: #ffffff !important;">red</code>
</button>
<button color-background="#ffffff">
<code style="background: var(--color-white); color: #000000 !important;">white</code>
<code style="background: var(--color-white) !important; color: #000000 !important;">white</code>
</button>
4 changes: 3 additions & 1 deletion docs/nav/styles/components.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Components

January 21, 2023

---

Expand Down
4 changes: 3 additions & 1 deletion docs/nav/styles/favicon.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Favicon

January 17, 2023

---

Expand Down
28 changes: 15 additions & 13 deletions docs/nav/styles/fonts.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Fonts

January 17, 2023

---

Expand All @@ -14,22 +16,22 @@ theme:
```

<button style-site-name="normal">
<code class="normal" style="background: var(--color-white); color: #000000 !important;">normal</code>
<code class="normal" style="background: var(--color-white) !important; color: #000000 !important;">normal</code>
</button>
<button style-site-name="bold">
<code class="bold" style="background: var(--color-white); color: #000000 !important;">bold</code>
<code class="bold" style="background: var(--color-white) !important; color: #000000 !important;">bold</code>
</button>
<button style-site-name="italic">
<code class="italic" style="background: var(--color-white); color: #000000 !important;">italic</code>
<code class="italic" style="background: var(--color-white) !important; color: #000000 !important;">italic</code>
</button>
<button style-site-name="scratched">
<code class="scratched" style="background: var(--color-white); color: #000000 !important;">scratched</code>
<code class="scratched" style="background: var(--color-white) !important; color: #000000 !important;">scratched</code>
</button>
<button style-site-name="underline">
<code class="underline" style="background: var(--color-white); color: #000000 !important;">underline</code>
<code class="underline" style="background: var(--color-white) !important; color: #000000 !important;">underline</code>
</button>
<button style-site-name="overline">
<code class="overline" style="background: var(--color-white); color: #000000 !important;">overline</code>
<code class="overline" style="background: var(--color-white) !important; color: #000000 !important;">overline</code>
</button>


Expand All @@ -43,20 +45,20 @@ theme:
```

<button style-title="normal">
<code class="normal" style="background: var(--color-white); color: #000000 !important;">normal</code>
<code class="normal" style="background: var(--color-white) !important; color: #000000 !important;">normal</code>
</button>
<button style-title="bold">
<code class="bold" style="background: var(--color-white); color: #000000 !important;">bold</code>
<code class="bold" style="background: var(--color-white) !important; color: #000000 !important;">bold</code>
</button>
<button style-title="italic">
<code class="italic" style="background: var(--color-white); color: #000000 !important;">italic</code>
<code class="italic" style="background: var(--color-white) !important; color: #000000 !important;">italic</code>
</button>
<button style-title="scratched">
<code class="scratched" style="background: var(--color-white); color: #000000 !important;">scratched</code>
<code class="scratched" style="background: var(--color-white) !important; color: #000000 !important;">scratched</code>
</button>
<button style-title="underline">
<code class="underline" style="background: var(--color-white); color: #000000 !important;">underline</code>
<code class="underline" style="background: var(--color-white) !important; color: #000000 !important;">underline</code>
</button>
<button style-title="overline">
<code class="overline" style="background: var(--color-white); color: #000000 !important;">overline</code>
<code class="overline" style="background: var(--color-white) !important; color: #000000 !important;">overline</code>
</button>
4 changes: 3 additions & 1 deletion docs/nav/styles/logo.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Jan 1, 2025
# Logo

January 17, 2023

---

Expand Down
14 changes: 14 additions & 0 deletions docs/nav/styles/sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Sidebar

January 28, 2025

---

## How to activate

- Default: false

```
theme:
sidebar: true
```
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ theme:
theme_style: light
site_name_style: normal
title_style: bold
sidebar: true
navigation_depth: 5
highlightjs: true
- yaml
- python
Expand All @@ -39,7 +41,7 @@ theme:
background: white
components:
site_name: true
title: true
title: false
menu: true
preview: true
footer: true
Loading