Skip to content

Commit 2b76bda

Browse files
AetherinoxAetherinox
committed
docs: update README
1 parent 8df2872 commit 2b76bda

File tree

1 file changed

+95
-72
lines changed

1 file changed

+95
-72
lines changed

‎README.md‎

Lines changed: 95 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
<div align="center">
2-
<h1>⭕ Obsidian Script Collection ⭕</h1>
2+
<h6>Dataview Snippets</h6>
3+
<h1>⭕ Obsidian Snippet Collection ⭕</h1>
4+
35
<br />
6+
47
<p>A collection of dataview scripts which can be utilized within your Obsidian.md notes to perform various tasks and display data.</p>
58

9+
<br />
610
<br />
711

812
</div>
913

1014
<div align="center">
1115

1216
<!-- prettier-ignore-start -->
13-
[![Version][badge-version-gh]][link-version-gh] [![Size][badge-size-gh]][badge-size-gh] [![Last Commit][badge-commit]][badge-commit] [![Contributors][badge-all-contributors]](#contributors-)
17+
[![Version][github-version-img]][github-version-uri]
18+
[![Build Status][github-build-img]][github-build-uri]
19+
[![Downloads][github-downloads-img]][github-downloads-uri]
20+
[![Size][github-size-img]][github-size-img]
21+
[![Last Commit][github-commit-img]][github-commit-img]
22+
[![Contributors][contribs-all-img]](#contributors-)
1423
<!-- prettier-ignore-end -->
1524

1625
</div>
@@ -21,20 +30,6 @@
2130

2231
<br />
2332

24-
## About
25-
This repo originally started a single **Table of Contents** script which displays at the top of your obsidian note. However, numerous other scripts have been added since then.
26-
27-
The snippets in this repo require you to download and install the following:
28-
- [Obsidian.md](obsidian.md/)
29-
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)
30-
31-
<br />
32-
33-
---
34-
35-
<br />
36-
37-
## Table of Contents <!-- omit from toc -->
3833
- [About](#about)
3934
- [Snippets](#snippets)
4035
- [Table of Contents: Version 1](#table-of-contents-version-1)
@@ -47,11 +42,24 @@ The snippets in this repo require you to download and install the following:
4742
- [Alphabetized List: Version 1](#alphabetized-list-version-1)
4843
- [Contributors ✨](#contributors-)
4944

50-
<br /><br />
45+
<br />
5146

5247
---
5348

54-
<br /><br />
49+
<br />
50+
51+
## About
52+
This repo originally started a single **Table of Contents** script which displays at the top of your obsidian note. However, numerous other scripts have been added since then.
53+
54+
The snippets in this repo require you to download and install the following:
55+
- [Obsidian.md](obsidian.md/)
56+
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)
57+
58+
<br />
59+
60+
---
61+
62+
<br />
5563

5664
## Snippets
5765
The following snippets are available in this repo
@@ -296,7 +304,7 @@ This version **requires** you to install the following:
296304
<br />
297305

298306
## Contributors ✨
299-
We are always looking for contributors. If you feel that you can provide something useful to these Obsidian snippets, then we'd love to see your work. Before submitting your contribution, please review the following resources:
307+
We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:
300308

301309
- [Pull Request Procedure](.github/PULL_REQUEST_TEMPLATE.md)
302310
- [Contributor Policy](CONTRIBUTING.md)
@@ -310,8 +318,12 @@ Want to help but can't write code?
310318

311319
The following people have helped get this project going:
312320

321+
<br />
322+
323+
<div align="center">
324+
313325
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
314-
[![Contributors][badge-all-contributors]](#contributors-)
326+
[![Contributors][contribs-all-img]](#contributors-)
315327
<!-- ALL-CONTRIBUTORS-BADGE:END -->
316328

317329
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -320,70 +332,81 @@ The following people have helped get this project going:
320332
<table>
321333
<tbody>
322334
<tr>
323-
<td align="center" valign="top" width="14.28%"><a href="https://gitlab.com/Aetherinox"><img src="https://avatars.githubusercontent.com/u/118329232?v=4?s=40" width="40px;" alt="Aetherinox"/><br /><sub><b>Aetherinox</b></sub></a><br /><a href="https://github.com/Aetherinox/obsidian-dataview-snippets/commits?author=Aetherinox" title="Code">💻</a> <a href="#projectManagement-Aetherinox" title="Project Management">📆</a> <a href="#fundingFinding-Aetherinox" title="Funding Finding">🔍</a></td>
335+
<td align="center" valign="top"><a href="https://gitlab.com/Aetherinox"><img src="https://avatars.githubusercontent.com/u/118329232?v=4?s=40" width="80px;" alt="Aetherinox"/><br /><sub><b>Aetherinox</b></sub></a><br /><a href="https://github.com/Aetherinox/obsidian-dataview-snippets/commits?author=Aetherinox" title="Code">💻</a> <a href="#projectManagement-Aetherinox" title="Project Management">📆</a> <a href="#fundingFinding-Aetherinox" title="Funding Finding">🔍</a></td>
324336
</tr>
325337
</tbody>
326338
</table>
327-
328-
<!-- markdownlint-restore -->
329-
<!-- prettier-ignore-end -->
330-
331-
<!-- ALL-CONTRIBUTORS-LIST:END -->
332-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
333-
<!-- prettier-ignore-start -->
334-
<!-- markdownlint-disable -->
335-
<!-- markdownlint-restore -->
336-
<!-- prettier-ignore-end -->
337-
<!-- ALL-CONTRIBUTORS-LIST:END -->
338-
339-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
340-
<!-- prettier-ignore-start -->
341-
<!-- markdownlint-disable -->
339+
</div>
342340
<!-- markdownlint-restore -->
343341
<!-- prettier-ignore-end -->
344-
345342
<!-- ALL-CONTRIBUTORS-LIST:END -->
346343

347-
348-
349344
<br />
350345
<br />
351346

352347
<!-- prettier-ignore-start -->
348+
<!-- markdownlint-disable -->
349+
353350
<!-- BADGE > GENERAL -->
354-
[link-general-npm]: https://npmjs.com
355-
[link-general-nodejs]: https://nodejs.org
356-
[link-npmtrends]: http://npmtrends.com/obsidian-gistr
351+
[general-npmjs-uri]: https://npmjs.com
352+
[general-nodejs-uri]: https://nodejs.org
353+
[general-npmtrends-uri]: http://npmtrends.com/obsidian-dataview-snippets
354+
357355
<!-- BADGE > VERSION > GITHUB -->
358-
[badge-version-gh]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-dataview-snippets?logo=GitHub&label=Version&color=ba5225
359-
[link-version-gh]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases
356+
[github-version-img]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-dataview-snippets?logo=GitHub&label=Version&color=ba5225
357+
[github-version-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases
358+
360359
<!-- BADGE > VERSION > NPMJS -->
361-
[badge-version-npm]: https://img.shields.io/npm/v/obsidian-gistr?logo=npm&label=Version&color=ba5225
362-
[link-version-npm]: https://npmjs.com/package/obsidian-gistr
363-
<!-- BADGE > LICENSE -->
364-
[badge-license-mit]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0
365-
[link-license-mit]: https://github.com/Aetherinox/obsidian-dataview-snippets/blob/main/LICENSE
366-
<!-- BADGE > BUILD -->
367-
[badge-build]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release-npm.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
368-
[link-build]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/release-npm.yml
369-
<!-- BADGE > DOWNLOAD COUNT -->
370-
[badge-downloads-gh]: https://img.shields.io/github/downloads/Aetherinox/obsidian-dataview-snippets/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892
371-
[link-downloads-gh]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases
372-
[badge-downloads-npm]: https://img.shields.io/npm/dw/%40aetherinox%2Fmarked-alert-fa?logo=npm&&label=Downloads&color=376892
373-
[link-downloads-npm]: https://npmjs.com/package/obsidian-gistr
374-
<!-- BADGE > DOWNLOAD SIZE -->
375-
[badge-size-gh]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-dataview-snippets?logo=github&label=Size&color=59702a
376-
[link-size-gh]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases
377-
[badge-size-npm]: https://img.shields.io/npm/unpacked-size/obsidian-gistr/latest?logo=npm&label=Size&color=59702a
378-
[link-size-npm]: https://npmjs.com/package/obsidian-gistr
379-
<!-- BADGE > COVERAGE -->
380-
[badge-coverage]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-dataview-snippets?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e
381-
[link-coverage]: https://codecov.io/github/Aetherinox/obsidian-dataview-snippets
360+
[npm-version-img]: https://img.shields.io/npm/v/obsidian-dataview-snippets?logo=npm&label=Version&color=ba5225
361+
[npm-version-uri]: https://npmjs.com/package/obsidian-dataview-snippets
362+
363+
<!-- BADGE > VERSION > PYPI -->
364+
[pypi-version-img]: https://img.shields.io/pypi/v/obsidian-dataview-snippets-plugin
365+
[pypi-version-uri]: https://pypi.org/project/obsidian-dataview-snippets-plugin/
366+
367+
<!-- BADGE > LICENSE > MIT -->
368+
[license-mit-img]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0
369+
[license-mit-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/blob/main/LICENSE
370+
371+
<!-- BADGE > GITHUB > DOWNLOAD COUNT -->
372+
[github-downloads-img]: https://img.shields.io/github/downloads/Aetherinox/obsidian-dataview-snippets/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892
373+
[github-downloads-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases
374+
375+
<!-- BADGE > NPMJS > DOWNLOAD COUNT -->
376+
[npmjs-downloads-img]: https://img.shields.io/npm/dw/%40aetherinox%2Fmkdocs-link-embeds?logo=npm&&label=Downloads&color=376892
377+
[npmjs-downloads-uri]: https://npmjs.com/package/obsidian-dataview-snippets
378+
379+
<!-- BADGE > GITHUB > DOWNLOAD SIZE -->
380+
[github-size-img]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-dataview-snippets?logo=github&label=Size&color=59702a
381+
[github-size-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases
382+
383+
<!-- BADGE > NPMJS > DOWNLOAD SIZE -->
384+
[npmjs-size-img]: https://img.shields.io/npm/unpacked-size/obsidian-dataview-snippets/latest?logo=npm&label=Size&color=59702a
385+
[npmjs-size-uri]: https://npmjs.com/package/obsidian-dataview-snippets
386+
387+
<!-- BADGE > CODECOV > COVERAGE -->
388+
[codecov-coverage-img]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-dataview-snippets?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e
389+
[codecov-coverage-uri]: https://codecov.io/github/Aetherinox/obsidian-dataview-snippets
390+
382391
<!-- BADGE > ALL CONTRIBUTORS -->
383-
[badge-all-contributors]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-dataview-snippets?logo=contributorcovenant&color=de1f6f&label=contributors
384-
[link-all-contributors]: https://github.com/all-contributors/all-contributors
385-
[badge-tests]: https://img.shields.io/github/actions/workflow/status/Aetherinox/marked-alert-fa/npm-tests.yml?logo=github&label=Tests&color=2c6488
386-
[link-tests]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/tests.yml
387-
[badge-commit]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-dataview-snippets?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131
388-
[link-commit]: https://github.com/Aetherinox/obsidian-dataview-snippets/commits/main/
389-
<!-- prettier-ignore-end -->
392+
[contribs-all-img]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-dataview-snippets?logo=contributorcovenant&color=de1f6f&label=contributors
393+
[contribs-all-uri]: https://github.com/all-contributors/all-contributors
394+
395+
<!-- BADGE > GITHUB > BUILD > NPM -->
396+
[github-build-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
397+
[github-build-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/release.yml
398+
399+
<!-- BADGE > GITHUB > BUILD > Pypi -->
400+
[github-build-pypi-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release-pypi.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
401+
[github-build-pypi-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/pypi-release.yml
402+
403+
<!-- BADGE > GITHUB > TESTS -->
404+
[github-tests-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/npm-tests.yml?logo=github&label=Tests&color=2c6488
405+
[github-tests-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/npm-tests.yml
406+
407+
<!-- BADGE > GITHUB > COMMIT -->
408+
[github-commit-img]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-dataview-snippets?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131
409+
[github-commit-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/commits/main/
410+
411+
<!-- prettier-ignore-end -->
412+
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)