Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
escwxyz committed Apr 2, 2023
1 parent 66f87a5 commit f48d62d
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 10 deletions.
24 changes: 24 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -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
}
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

## 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.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit f48d62d

Please sign in to comment.