Skip to content

Commit 91cdd8a

Browse files
committed
docs: fix broken links & improve formatting
1 parent 47822fe commit 91cdd8a

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Search ALL the docs
2-
![GitHub Downloads](https://img.shields.io/github/downloads/chrisgrieser/alfred-docs-searches/total?label=GitHub%20Downloads&style=plastic&logo=github)
3-
![Alfred Gallery Downloads](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fchrisgrieser%2F.config%2Frefs%2Fheads%2Fmain%2FAlfred.alfredpreferences%2Falfred-workflow-download-count.yaml&query=alfred-docs-searches&style=plastic&logo=alfred&label=Gallery%20Downloads&color=%235C1F87)
4-
![Latest Release](https://img.shields.io/github/v/release/chrisgrieser/alfred-docs-searches?label=Latest%20Release&style=plastic)
2+
![GitHub downloads](https://img.shields.io/github/downloads/chrisgrieser/alfred-docs-searches/total?label=GitHub%20Downloads&style=plastic&logo=github)
3+
![Alfred gallery downloads](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fchrisgrieser%2F.config%2Frefs%2Fheads%2Fmain%2FAlfred.alfredpreferences%2Falfred-workflow-download-count.yaml&query=alfred-docs-searches&style=plastic&logo=alfred&label=Gallery%20Downloads&color=%235C1F87)
4+
![Latest release](https://img.shields.io/github/v/release/chrisgrieser/alfred-docs-searches?label=Latest%20Release&style=plastic)
55

66
Search hundreds of documentation sites from DevDocs and other sources via
77
Alfred.
@@ -14,12 +14,12 @@ Alfred.
1414

1515
- [Installation](#installation)
1616
- [DevDocs](#devdocs)
17-
* [Usage](#usage)
18-
* [Pinning specific versions](#pinning-specific-versions)
19-
* [Icons](#icons)
17+
* [Usage](#usage)
18+
* [Pinning specific versions](#pinning-specific-versions)
19+
* [Icons](#icons)
2020
- [Extras](#extras)
21-
* [Documentation sites](#documentation-sites)
22-
* [Utilities](#utilities)
21+
* [Documentation sites](#documentation-sites)
22+
* [Utilities](#utilities)
2323
- [Reload caches](#reload-caches)
2424
- [Maintenance notes](#maintenance-notes)
2525
- [About the developer](#about-the-developer)
@@ -72,7 +72,7 @@ the directory `./devdocs/icons/{keyword}.png`. PRs are welcome.
7272
- `sc`: shellcheck wiki
7373
- `pandoc`: pandoc user manual
7474
- `wt`: WezTerm docs
75-
- `just`: [just (task runner) docs](https://just.systems/man/en/)
75+
- `just`: [just docs](https://just.systems/man/en/)
7676
- `yq`: yq docs
7777
- `oh`: Obsidian help
7878
- `odd`: Obsidian developer docs
@@ -98,16 +98,16 @@ refreshing the cache via the Alfred keyword `:docs-reload`.
9898

9999
## Maintenance notes
100100
1. **Remote**: Twice per month, a [GitHub
101-
Action](https://github.com/chrisgrieser/alfred-docs-searches/blob/main/.github/workflows/update-available-devdocs.yml)
102-
is run that checks for devdocs updates. If updates are found, the
103-
[keyword-slug-map](https://github.com/chrisgrieser/alfred-docs-searches/blob/main/.github/keyword-slug-map.json)
104-
available on this GitHub remote is updated. The `info.plist` is also updated
105-
in case not only a new version, but an entirely new documentation site
106-
becomes available.
101+
Action](./.github/workflows/update-devdocs.yml) is run that checks for
102+
devdocs updates. If updates are found, the
103+
[keyword-slug-map](./.github/caches/devdocs-keyword-slug-map.json) available
104+
on this GitHub remote is updated. The `info.plist` is also updated in case
105+
not only a new version, but an entirely new documentation site becomes
106+
available.
107107
2. **Local**: Every week, the locally available workflow fetches an update from
108-
the `keymap-slug-map` and the `info.plist` files from the GitHub remote. The update to the
109-
`info.plist` is required, so that newly available documentation sites also
110-
show up in the dropdown menus of the workflow configuration.
108+
the `keymap-slug-map` and the `info.plist` files from the GitHub remote. The
109+
update to the `info.plist` is required, so that newly available documentation
110+
sites also show up in the dropdown menus of the workflow configuration.
111111
3. This means that any devdocs update is available to the user at most after
112112
three weeks. (The local cache can be manually updated via the Alfred keyword
113113
via `:docs-reload` to remove the seven-day delay.)

0 commit comments

Comments
 (0)