Skip to content

Commit 599c095

Browse files
committed
docs: linting
1 parent 0f51ee4 commit 599c095

File tree

3 files changed

+37
-50
lines changed

3 files changed

+37
-50
lines changed

.harper-dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
cursorline

README.md

Lines changed: 34 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Shimmering Focus ⟡
1+
# Shimmering Focus ⟡ <!-- rumdl-disable-line MD063 -->
22
![Downloads in Obsidian](https://img.shields.io/badge/downloads-291974-6E4E9B?style=plastic&logo=obsidian&color=%23483699)
33
![GitHub stars](https://img.shields.io/github/stars/chrisgrieser/shimmering-focus?style=plastic&label=%E2%98%85%20Stars)
44
![Last commit](https://img.shields.io/github/last-commit/chrisgrieser/shimmering-focus?style=plastic)
@@ -16,33 +16,31 @@ downloaded theme in the Obsidian theme store.
1616
<!-- toc -->
1717

1818
- [General information](#general-information)
19-
* [Design philosophy](#design-philosophy)
20-
* [Features](#features)
21-
* [Commands](#commands)
19+
[Design philosophy](#design-philosophy)
20+
[Features](#features)
21+
[Commands](#commands)
2222
- [Advanced customization](#advanced-customization)
23-
* [Create your own color scheme](#create-your-own-color-scheme)
24-
* [Standalone snippets](#standalone-snippets)
25-
* [Contribute to the theme](#contribute-to-the-theme)
23+
[Create your own color scheme](#create-your-own-color-scheme)
24+
[Standalone snippets](#standalone-snippets)
25+
[Contribute to the theme](#contribute-to-the-theme)
2626
- [Credits](#credits)
27-
* [Licenses](#licenses)
28-
* [Thanks](#thanks)
29-
* [About the creator](#about-the-creator)
27+
[Licenses](#licenses)
28+
[Thanks](#thanks)
29+
[About the creator](#about-the-creator)
3030

3131
<!-- tocstop -->
3232

3333
## General information
3434

3535
### Design philosophy
36-
- **Radical minimalism:** As opposed to a minimalism of *colors*, this theme
36+
- **Radical minimalism:** As opposed to minimalistic *colors*, this theme
3737
focuses on a minimalistic *user interface*: UI elements not relevant for
3838
keyboard users are hidden, or only shown when needed. All hidden UI elements
39-
can be permanently re-enabled with the [Style Settings
40-
Plugin](https://obsidian.md/plugins?id=obsidian-style-settings).
39+
can be permanently re-enabled with the [Style Settings Plugin](https://obsidian.md/plugins?id=obsidian-style-settings).
4140
- **Condensed display of information:** Unnecessary padding and white-space is
4241
removed, which is beneficial for small screens or higher zoom levels.
4342
- **High customizability:** Over a hundred customization options available
44-
via the [Style Settings
45-
Plugin](https://obsidian.md/plugins?id=obsidian-style-settings).
43+
via the [Style Settings Plugin](https://obsidian.md/plugins?id=obsidian-style-settings).
4644

4745
### Features
4846
- **Smart hiding of UI elements**: The tab bar is only shown when there is more
@@ -65,8 +63,7 @@ downloaded theme in the Obsidian theme store.
6563
Plugin](https://obsidian.md/plugins?id=obsidian-style-settings).
6664

6765
### Commands
68-
When the [Style Settings
69-
Plugin](https://obsidian.md/plugins?id=obsidian-style-settings) is installed,
66+
When the [Style Settings Plugin](https://obsidian.md/plugins?id=obsidian-style-settings) is installed,
7067
*Shimmering Focus* adds commands for toggling theme features:
7168
- Toggle folding of URLs (Source Mode)
7269
- Toggle between reduced and original image size (reduced size can be set in the
@@ -128,8 +125,7 @@ Draft PR or an issue.
128125
All relevant source files are located in the [source](./source) directory, and
129126
will be compiled via GitHub action when pushed to GitHub.
130127

131-
The theme uses `lightning-css` for
132-
[syntax-lowering](https://lightningcss.dev/transpilation.html#syntax-lowering)
128+
The theme uses `lightning-css` for [syntax-lowering](https://lightningcss.dev/transpilation.html#syntax-lowering)
133129
in its build. That means you can use modern CSS features like
134130
[CSS-nesting](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_nesting),
135131
as the resulting `theme.css` will still be compatible with older Obsidian
@@ -141,45 +137,33 @@ The theme is written completely dependency-free in vanilla CSS.
141137
## Credits
142138

143139
### Licenses
144-
- This theme is licensed under the [MIT
145-
License](https://github.com/chrisgrieser/shimmering-focus/blob/main/LICENSE).
140+
- This theme is licensed under the [MIT License](https://github.com/chrisgrieser/shimmering-focus/blob/main/LICENSE).
146141
- The two embedded fonts `iA Writer Quattro` and `Recursive` are licensed under
147142
the [SIL Open Font License](https://www.wikiwand.com/en/SIL_Open_Font_License).
148-
- The embedded `Material Icon` font is licensed under the [Apache
149-
License](https://developers.google.com/fonts/docs/material_icons#licensing).
143+
- The embedded `Material Icon` font is licensed under the [Apache License](https://developers.google.com/fonts/docs/material_icons#licensing).
150144

151145
### Thanks
152146
- This theme includes snippets and/or ideas from:
153-
[@SlRvb](https://github.com/SlRvb), [@Atlas](https://github.com/zcysxy),
154-
[@CecilaMay](https://github.com/ceciliamay),
155-
[@DamianKorcz](https://github.com/damiankorcz),
156-
[@Mara-Li](https://github.com/Mara-Li), [@kepano](https://github.com/kepano),
157-
[@jdanielmourao](https://github.com/jdanielmourao),
158-
[@deathau](https://github.com/deathau/),
159-
[@MelvinTing](https://github.com/tingmelvin/),
160-
[@EmrieCandera](https://github.com/Emrie-Candera),
161-
[@Chetachie](https://github.com/chetachiezikeuzor),
162-
[@pryley](https://github.com/pryley), and
163-
[@joelatschool](https://github.com/joelatschool).
147+
[@SlRvb](https://github.com/SlRvb), [@Atlas](https://github.com/zcysxy), [@CecilaMay](https://github.com/ceciliamay), [@DamianKorcz](https://github.com/damiankorcz),
148+
[@Mara-Li](https://github.com/Mara-Li), [@kepano](https://github.com/kepano), [@jdanielmourao](https://github.com/jdanielmourao), [@deathau](https://github.com/deathau/),
149+
[@MelvinTing](https://github.com/tingmelvin/), [@EmrieCandera](https://github.com/Emrie-Candera),
150+
[@Chetachie](https://github.com/chetachiezikeuzor), [@pryley](https://github.com/pryley), and [@joelatschool](https://github.com/joelatschool).
164151
- Many theme features are only possible thanks to the [Style Settings
165-
Plugin](https://obsidian.md/plugins?id=obsidian-style-settings) by
166-
[@mgmeyers](https://github.com/mgmeyers).
152+
Plugin](https://obsidian.md/plugins?id=obsidian-style-settings) by [@mgmeyers](https://github.com/mgmeyers).
167153
- Thanks for helping me out in my early days of learning CSS:
168-
[@SlRvb](https://github.com/SlRvb),
169-
[@javalent](https://github.com/valentine195), and
170-
[@NothingIsLost](https://github.com/nothingislost).
154+
[@SlRvb](https://github.com/SlRvb), [@javalent](https://github.com/valentine195), and [@NothingIsLost](https://github.com/nothingislost).
171155
- Community-made color schemes:
172-
* `Gamma` created in collaboration with `@lkadre`.
173-
* `Everforest` by
174-
[@neuromancer](https://github.com/chrisgrieser/shimmering-focus/discussions/291).
175-
* `Coffee` by
176-
[@keara](https://github.com/chrisgrieser/shimmering-focus/discussions/274)
177-
and inspired by the [Primary
178-
theme](https://github.com/primary-theme/obsidian).
179-
* `Gruvbox` dark variant by
180-
[@jasht1](https://github.com/chrisgrieser/shimmering-focus/discussions/311),
181-
light variant by
182-
[robrecord](https://github.com/chrisgrieser/shimmering-focus/discussions/257).
156+
`Gamma` created in collaboration with `@lkadre`.
157+
`Everforest` by
158+
[@neuromancer](https://github.com/chrisgrieser/shimmering-focus/discussions/291).
159+
- `Coffee` by
160+
[@keara](https://github.com/chrisgrieser/shimmering-focus/discussions/274)
161+
and inspired by the [Primary
162+
theme](https://github.com/primary-theme/obsidian).
163+
- `Gruvbox` dark variant by
164+
[@jasht1](https://github.com/chrisgrieser/shimmering-focus/discussions/311),
165+
light variant by
166+
[robrecord](https://github.com/chrisgrieser/shimmering-focus/discussions/257).
183167

184168
### About the creator
185169
In my day job, I am a sociologist studying the social mechanisms underlying the

source/INFO-dont-save-css-files-at-this-level.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# INFO
2+
13
> [!WARNING]
24
> Don't save `.css` files at this level.
35

0 commit comments

Comments
 (0)