Skip to content

Commit 7f59987

Browse files
committed
docs: Simplify README skill placement
1 parent 0225a7a commit 7f59987

1 file changed

Lines changed: 7 additions & 29 deletions

File tree

README.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,10 @@ A demo page (`test/fixture.html`) demonstrates all the passing HTML features.
1515

1616
![](demo.png)
1717

18-
## Installation
18+
## Install Obsidian Plugin
1919

20-
### Install from Obsidian directly
21-
22-
* Go to Obsidian Community Plugins: [community.obsidian.md/plugins/html-docs](https://community.obsidian.md/plugins/html-docs)
23-
* Click Install
24-
25-
### Install manually
26-
27-
1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/smcllns/obsidian-plugin-html-docs/releases/latest)
28-
2. Place those files into `<vault>/.obsidian/plugins/html-docs/`.
29-
3. Enable **HTML Docs** in Obsidian's Community Plugins settings.
30-
31-
Releases are built and signed by GitHub Actions ([.github/workflows/release.yml](.github/workflows/release.yml)) so the binaries carry a [build attestation](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds) you can verify against the source.
32-
33-
### Optional Agent Skill
34-
35-
There is an optional agent skill so your agent can author HTML that fits this plugin's sandbox, theme tokens, assets, and embeds.
36-
37-
- Skills CLI: `npx skills add smcllns/skills --skill obsidian-html-docs`
38-
- Manual: [smcllns/skills/skills/obsidian-html-docs/SKILL.md](https://github.com/smcllns/skills/blob/main/skills/obsidian-html-docs/SKILL.md)
20+
* Obsidian Community Plugins: [HTML Docs](https://community.obsidian.md/plugins/html-docs)
21+
* Optional Agent Skill: [obsidian-html-docs/SKILL.md](https://github.com/smcllns/skills/blob/main/skills/obsidian-html-docs/SKILL.md)
3922

4023
### Build and install from source
4124

@@ -79,17 +62,12 @@ Embed HTML docs like other Obsidian embeds. Embeds default to about 600px tall;
7962
![[doc.html|600x400]]
8063
```
8164

82-
Each iframe receives a one-way snapshot of Obsidian theme styles. HTML docs can use these CSS variables to match light/dark mode, theme colors, and fonts without giving the iframe permission to read Obsidian or the vault. Use fallbacks so files still work outside Obsidian:
65+
### Optional Agent Skill
8366

84-
```css
85-
:root {
86-
color-scheme: var(--obsidian-color-scheme, light dark);
87-
--bg: var(--obsidian-bg, light-dark(#fff, #0e1014));
88-
--text: var(--obsidian-text, light-dark(#16161a, #e7e9ec));
89-
}
90-
```
67+
There is an optional agent skill so your agent can author HTML that fits this plugin's sandbox, theme tokens, assets, and embeds.
9168

92-
Available CSS variables: `--obsidian-color-scheme`, `--obsidian-bg`, `--obsidian-bg-2`, `--obsidian-text`, `--obsidian-text-muted`, `--obsidian-accent`, `--obsidian-border`, `--obsidian-font`, `--obsidian-font-mono`.
69+
* Skills CLI: `npx skills add smcllns/skills --skill obsidian-html-docs`
70+
* Manual: [smcllns/skills/skills/obsidian-html-docs/SKILL.md](https://github.com/smcllns/skills/blob/main/skills/obsidian-html-docs/SKILL.md)
9371

9472
## Obsidian Plugin Docs
9573

0 commit comments

Comments
 (0)