Skip to content

Commit eff2d54

Browse files
committed
docs: update readme
1 parent 438740c commit eff2d54

File tree

1 file changed

+66
-53
lines changed

1 file changed

+66
-53
lines changed

README.md

Lines changed: 66 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
<div align="center">
2-
<h1>♾️ Gistr Plugin ♾️</h1>
2+
<h6>Obsidian.md Plugin</h6>
3+
<h1>♾️ Gistr ♾️</h1>
4+
35
<br />
4-
<p>A plugin for Obsidian.md which allows you to create, convert, and update notes from Obsidian to Github or Opengist.</p>
6+
7+
<p>A plugin for Obsidian.md which allows you to create, convert, and update notes from Obsidian to Github or Opengist. As well as integrate fully functional websites into your notes.</p>
58

69
<br />
710

811
<img src="https://github.com/Aetherinox/obsidian-gistr/assets/118329232/106bcb32-6c6f-423c-a8c6-c6aee3d31c65" width="630">
912

13+
<br />
1014
<br />
1115

1216
</div>
1317

1418
<div align="center">
1519

1620
<!-- prettier-ignore-start -->
17-
[![Version][badge-version-gh]][link-version-gh] [![Build Status][badge-build]][link-build] [![Downloads][badge-downloads-gh]][link-downloads-gh] [![Size][badge-size-gh]][badge-size-gh] [![Last Commit][badge-commit]][badge-commit] [![Contributors][badge-all-contributors]](#contributors-)
21+
[![Version][github-version-img]][github-version-uri] [![Build Status][github-build-img]][github-build-uri] [![Downloads][github-downloads-img]][github-downloads-uri] [![Size][github-size-img]][github-size-img] [![Last Commit][github-commit-img]][github-commit-img] [![Contributors][contribs-all-img]](#contributors-)
1822
<!-- prettier-ignore-end -->
1923

2024
</div>
@@ -398,8 +402,12 @@ Want to help but can't write code?
398402

399403
The following people have helped get this project going:
400404

405+
<br />
406+
407+
<div align="center">
408+
401409
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
402-
[![Contributors][badge-all-contributors]](#contributors-)
410+
[![Contributors][contribs-all-img]](#contributors-)
403411
<!-- ALL-CONTRIBUTORS-BADGE:END -->
404412

405413
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -408,76 +416,81 @@ The following people have helped get this project going:
408416
<table>
409417
<tbody>
410418
<tr>
411-
<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-gistr/commits?author=Aetherinox" title="Code">💻</a> <a href="#projectManagement-Aetherinox" title="Project Management">📆</a> <a href="#fundingFinding-Aetherinox" title="Funding Finding">🔍</a></td>
419+
<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-gistr/commits?author=Aetherinox" title="Code">💻</a> <a href="#projectManagement-Aetherinox" title="Project Management">📆</a> <a href="#fundingFinding-Aetherinox" title="Funding Finding">🔍</a></td>
412420
</tr>
413421
</tbody>
414422
</table>
415-
416-
<!-- markdownlint-restore -->
417-
<!-- prettier-ignore-end -->
418-
419-
<!-- ALL-CONTRIBUTORS-LIST:END -->
420-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
421-
<!-- prettier-ignore-start -->
422-
<!-- markdownlint-disable -->
423-
<!-- markdownlint-restore -->
424-
<!-- prettier-ignore-end -->
425-
<!-- ALL-CONTRIBUTORS-LIST:END -->
426-
427-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
428-
<!-- prettier-ignore-start -->
429-
<!-- markdownlint-disable -->
423+
</div>
430424
<!-- markdownlint-restore -->
431425
<!-- prettier-ignore-end -->
432-
433426
<!-- ALL-CONTRIBUTORS-LIST:END -->
434427

435428
<br />
436429
<br />
437430

438431
<!-- prettier-ignore-start -->
432+
<!-- markdownlint-disable -->
433+
439434
<!-- BADGE > GENERAL -->
440-
[link-general-npm]: https://npmjs.com
441-
[link-general-nodejs]: https://nodejs.org
442-
[link-npmtrends]: http://npmtrends.com/obsidian-gistr
435+
[general-npmjs-uri]: https://npmjs.com
436+
[general-nodejs-uri]: https://nodejs.org
437+
[general-npmtrends-uri]: http://npmtrends.com/obsidian-gistr
443438

444439
<!-- BADGE > VERSION > GITHUB -->
445-
[badge-version-gh]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-gistr?logo=GitHub&label=Version&color=ba5225
446-
[link-version-gh]: https://github.com/Aetherinox/obsidian-gistr/releases
440+
[github-version-img]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-gistr?logo=GitHub&label=Version&color=ba5225
441+
[github-version-uri]: https://github.com/Aetherinox/obsidian-gistr/releases
447442

448443
<!-- BADGE > VERSION > NPMJS -->
449-
[badge-version-npm]: https://img.shields.io/npm/v/obsidian-gistr?logo=npm&label=Version&color=ba5225
450-
[link-version-npm]: https://npmjs.com/package/obsidian-gistr
444+
[npm-version-img]: https://img.shields.io/npm/v/obsidian-gistr?logo=npm&label=Version&color=ba5225
445+
[npm-version-uri]: https://npmjs.com/package/obsidian-gistr
451446

452-
<!-- BADGE > LICENSE -->
453-
[badge-license-mit]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0
454-
[link-license-mit]: https://github.com/Aetherinox/obsidian-gistr/blob/main/LICENSE
447+
<!-- BADGE > VERSION > PYPI -->
448+
[pypi-version-img]: https://img.shields.io/pypi/v/obsidian-gistr-plugin
449+
[pypi-version-uri]: https://pypi.org/project/obsidian-gistr-plugin/
455450

456-
<!-- BADGE > BUILD -->
457-
[badge-build]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-gistr/npm-release.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
458-
[link-build]: https://github.com/Aetherinox/obsidian-gistr/actions/workflows/npm-release.yml
451+
<!-- BADGE > LICENSE > MIT -->
452+
[license-mit-img]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0
453+
[license-mit-uri]: https://github.com/Aetherinox/obsidian-gistr/blob/main/LICENSE
459454

460-
<!-- BADGE > DOWNLOAD COUNT -->
461-
[badge-downloads-gh]: https://img.shields.io/github/downloads/Aetherinox/obsidian-gistr/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892
462-
[link-downloads-gh]: https://github.com/Aetherinox/obsidian-gistr/releases
463-
[badge-downloads-npm]: https://img.shields.io/npm/dw/%40aetherinox%2Fobsidian-gistr?logo=npm&&label=Downloads&color=376892
464-
[link-downloads-npm]: https://npmjs.com/package/obsidian-gistr
455+
<!-- BADGE > GITHUB > DOWNLOAD COUNT -->
456+
[github-downloads-img]: https://img.shields.io/github/downloads/Aetherinox/obsidian-gistr/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892
457+
[github-downloads-uri]: https://github.com/Aetherinox/obsidian-gistr/releases
465458

466-
<!-- BADGE > DOWNLOAD SIZE -->
467-
[badge-size-gh]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-gistr?logo=github&label=Size&color=59702a
468-
[link-size-gh]: https://github.com/Aetherinox/obsidian-gistr/releases
469-
[badge-size-npm]: https://img.shields.io/npm/unpacked-size/obsidian-gistr/latest?logo=npm&label=Size&color=59702a
470-
[link-size-npm]: https://npmjs.com/package/obsidian-gistr
459+
<!-- BADGE > NPMJS > DOWNLOAD COUNT -->
460+
[npmjs-downloads-img]: https://img.shields.io/npm/dw/%40aetherinox%2Fmkdocs-link-embeds?logo=npm&&label=Downloads&color=376892
461+
[npmjs-downloads-uri]: https://npmjs.com/package/obsidian-gistr
471462

472-
<!-- BADGE > COVERAGE -->
473-
[badge-coverage]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-gistr?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e
474-
[link-coverage]: https://codecov.io/github/Aetherinox/obsidian-gistr
463+
<!-- BADGE > GITHUB > DOWNLOAD SIZE -->
464+
[github-size-img]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-gistr?logo=github&label=Size&color=59702a
465+
[github-size-uri]: https://github.com/Aetherinox/obsidian-gistr/releases
466+
467+
<!-- BADGE > NPMJS > DOWNLOAD SIZE -->
468+
[npmjs-size-img]: https://img.shields.io/npm/unpacked-size/obsidian-gistr/latest?logo=npm&label=Size&color=59702a
469+
[npmjs-size-uri]: https://npmjs.com/package/obsidian-gistr
470+
471+
<!-- BADGE > CODECOV > COVERAGE -->
472+
[codecov-coverage-img]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-gistr?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e
473+
[codecov-coverage-uri]: https://codecov.io/github/Aetherinox/obsidian-gistr
475474

476475
<!-- BADGE > ALL CONTRIBUTORS -->
477-
[badge-all-contributors]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-gistr?logo=contributorcovenant&color=de1f6f&label=contributors
478-
[link-all-contributors]: https://github.com/all-contributors/all-contributors
479-
[badge-tests]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-gistr/npm-tests.yml?logo=github&label=Tests&color=2c6488
480-
[link-tests]: https://github.com/Aetherinox/obsidian-gistr/actions/workflows/tests.yml
481-
[badge-commit]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-gistr?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131
482-
[link-commit]: https://github.com/Aetherinox/obsidian-gistr/commits/main/
476+
[contribs-all-img]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-gistr?logo=contributorcovenant&color=de1f6f&label=contributors
477+
[contribs-all-uri]: https://github.com/all-contributors/all-contributors
478+
479+
<!-- BADGE > GITHUB > BUILD > NPM -->
480+
[github-build-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-gistr/npm-release.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
481+
[github-build-uri]: https://github.com/Aetherinox/obsidian-gistr/actions/workflows/npm-release.yml
482+
483+
<!-- BADGE > GITHUB > BUILD > Pypi -->
484+
[github-build-pypi-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-gistr/release-pypi.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
485+
[github-build-pypi-uri]: https://github.com/Aetherinox/obsidian-gistr/actions/workflows/pypi-release.yml
486+
487+
<!-- BADGE > GITHUB > TESTS -->
488+
[github-tests-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-gistr/npm-tests.yml?logo=github&label=Tests&color=2c6488
489+
[github-tests-uri]: https://github.com/Aetherinox/obsidian-gistr/actions/workflows/npm-tests.yml
490+
491+
<!-- BADGE > GITHUB > COMMIT -->
492+
[github-commit-img]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-gistr?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131
493+
[github-commit-uri]: https://github.com/Aetherinox/obsidian-gistr/commits/main/
494+
483495
<!-- prettier-ignore-end -->
496+
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)