diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..2489fb8 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,24 @@ +{ + "projectName": "remark-obsidian-callout", + "projectOwner": "escwxyz", + "files": [ + "README.md" + ], + "imageSize": 100, + "contributors": [ + { + "login": "chovanecadam", + "name": "Adam Chovanec", + "avatar_url": "https://avatars.githubusercontent.com/u/23148601?v=4", + "profile": "https://github.com/chovanecadam", + "contributions": [ + "bug" + ] + } + ], + "repoType": "github", + "contributorsPerLine": 7, + "repoHost": "https://github.com", + "commitConvention": "angular", + "skipCi": true +} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index f74d88c..2a5e6cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,13 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +### Changed + +- Update readme.md +- Update dependencies + ## 1.1.0-beta.0 - 2023-04-02 + ### Fixed + - Improve github actions, to avoid missing built files. ## 1.0.7 - 2023-04-02 + ### Added + - Update github actions for auto release and plublishing. ### Fixed + - Fixed empty blockquote (#1). diff --git a/README.md b/README.md index e04bf17..5676a79 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -## remark-obsidian-callout +# remark-obsidian-callout [![NPM](https://img.shields.io/npm/dw/remark-obsidian-callout?style=for-the-badge)](https://www.npmjs.com/package/remark-obsidian-callout) A remark plugin to parse Obsidian's callout syntax. -### What is this +## What is this This is a [remark](https://github.com/remarkjs/remark) plugin that parses [Obsidian's callout](https://help.obsidian.md/Editing+and+formatting/Callouts) syntax, and adds custom data attributes and classes to the HTML elements for further customizations. -### Why +## Why Because I am currently building my digital garden using [Astro](https://astro.build/) and Obsidian. Despite the great support for the Markdown that Astro brings, we still need to some work to customize the rendered output. -### How to use +## How to use -#### Installation +### Installation First, install the plugin with your favorite package manager. @@ -89,7 +89,7 @@ blockquote[data-callout="error"] { } ``` -#### Configuration +### Configuration To configure the plugin, simply add the following options to your `astro.config.mjs` file. For example: @@ -184,14 +184,27 @@ const defaultConfig: Config = { }; ``` -### TODOs & Limitations +## TODOs & Limitations - [ ] Currently does not support nested callouts, as the usecase of this should be uncommon -### Support +## Support If you have any questions or suggestions, feel free to open an issue. -### Credits +## Contributors + +Big thanks go to these wonderful people: + + + + + + + + + + +## Credits Thanks to [remark-github-beta-blockquote-admonitions](https://github.com/myl7/remark-github-beta-blockquote-admonitions) for guidance on how to set up testing. diff --git a/package.json b/package.json index 9dcd9bd..fe4c570 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "remark-obsidian-callout", - "version": "1.1.0-beta.0", + "version": "1.1.1", "description": "A remark plugin to parse Obsidian callouts.", "main": "dist/index.js", "type": "module",