Skip to content

Commit c8793b8

Browse files
committed
fix+docs: fix action + added maintance disclaimer
1 parent 4916e57 commit c8793b8

3 files changed

Lines changed: 13 additions & 8 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ on:
55
branches:
66
- 'main'
77

8-
permissions:
9-
contents: read
10-
pages: write
11-
128
jobs:
139
build:
1410
name: Deploy

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
![](screenshot.png?raw=true)
44

5+
> [!IMPORTANT]
6+
> This project is in maintenance mode and will be archived. Only critical updates will be applied.
7+
58
## Installation
69

710
First install the theme into the `themes` directory with one of these options:
@@ -65,7 +68,7 @@ This theme uses no special font, just the browsers default monospace font. Yes,
6568

6669
#### Darkmode
6770

68-
This theme supports dark and light mode. Currently this will be only switched based on the users preffered system theme. But a manual switch will follow in the future in the footer (see the todo).
71+
This theme supports dark and light mode. Currently this will be only switched based on the users preferred system theme. But a manual switch will follow in the future in the footer (see the todo).
6972

7073
| light | dark |
7174
|-|-|
@@ -83,7 +86,13 @@ Which results in a total loading size of `3kB + 3kB + 17kB + 2kB = 25kB`.
8386

8487
#### Syntax Highlighting
8588

86-
As I didn't want to invest any time in creating an own syntax color schema for this theme, I suggest to use `visual-studio-dark`, which is the same one used in the demo page.
89+
As I didn't want to invest any time in creating an own syntax color schema for this theme, I suggest to use some of thge default themes. For the demo page I used:
90+
91+
```toml
92+
[markdown.highlighting]
93+
light_theme = "github-light"
94+
dark_theme = "github-dark"
95+
```
8796

8897
#### Customization
8998

@@ -106,4 +115,4 @@ $separator-decoration: "//////";
106115

107116
![GitHub](https://img.shields.io/github/license/oltdaniel/dose)
108117

109-
This project was created by [Daniel Oltmanns](https://github.com/oltdaniel) and has been imporved by these [contributors](https://github.com/oltdaniel/dose/graphs/contributors).
118+
This project was created by [Daniel Oltmanns](https://github.com/oltdaniel) and has been improved by these [contributors](https://github.com/oltdaniel/dose/graphs/contributors).

config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ taxonomies = [
2424
]
2525

2626
[markdown.highlighting]
27-
light_theme = "github-light"
27+
light_theme = "github-light"
2828
dark_theme = "github-dark"
2929

3030
[extra]

0 commit comments

Comments
 (0)