Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bent10/marked-extensions
Marked extensions workspace
https://github.com/bent10/marked-extensions
extensions gfm markdown marked md plugins
Last synced: 1 day ago
JSON representation
Marked extensions workspace
- Host: GitHub
- URL: https://github.com/bent10/marked-extensions
- Owner: bent10
- License: mit
- Created: 2023-09-24T07:42:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-26T12:22:48.000Z (2 months ago)
- Last Synced: 2024-07-28T09:43:16.848Z (2 months ago)
- Topics: extensions, gfm, markdown, marked, md, plugins
- Language: TypeScript
- Homepage: https://www.npmjs.com/search?q=keywords:stilearning-marked-extensions
- Size: 556 KB
- Stars: 29
- Watchers: 2
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# marked-extensions
[Marked](https://github.com/markedjs/marked) extensions workspace.
## Packages
| Package | Description | Version (click for changelog) |
| :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- |
| [marked-alert](packages/alert) | Enables [GFM alerts](https://github.com/orgs/community/discussions/16925) | [](packages/alert/changelog.md) |
| [marked-directive](packages/directive) | Supports [directives syntax](https://talk.commonmark.org/t/generic-directives-plugins-syntax/444) | [](packages/directive/changelog.md) |
| [marked-code-format](packages/code-format) | Formatting code blocks using Prettier | [](packages/code-format/changelog.md) |
| [marked-code-jsx-renderer](packages/code-jsx-renderer) | Render JSX code blocks using a custom renderer and components | [](packages/code-jsx-renderer/changelog.md) |
| [marked-code-preview](packages/code-preview) | Transform code blocks into code previews | [](packages/code-preview/changelog.md) |
| [marked-footnote](packages/footnote) | Enables [GFM footnotes](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes). | [](packages/footnote/changelog.md) |
| [marked-plaintify](packages/plaintify) | Converts Markdown to Plaintext | [](packages/plaintify/changelog.md) |
| [marked-sequential-hooks](packages/sequential-hooks) | Enables the sequential preprocessing and post-processing | [](packages/sequential-hooks/changelog.md) |
| [marked-shiki](packages/shiki) | Integrating [Shiki](https://shiki.style/) syntax highlighting | [](packages/shiki/changelog.md) |
### Sequential hooks
Incorporate the power of sequential hooks using the following packages within [sequential hooks](packages/sequential-hooks):
Show the example code 🚀
```js
import { Marked } from 'marked'
import markedSequentialHooks from 'marked-sequential-hooks'
const html = new Marked()
.use(
markedSequentialHooks({
markdownHooks: [mdHoook1(), mdHook2],
htmlHooks: [htmlHook1(), htmlHook2]
})
)
.parse('# Content')
console.log(html)
```
| Package | Types | Description | Version (click for changelog) |
| :--------------------------------------------------- | :------------- | :--------------------------------------------------- | :----------------------------------------------------------------------------------------------------- |
| [marked-hook-data](packages/hook-data) | `MarkdownHook` | A sequential hook to load data from files or objects | [](packages/hook-data/changelog.md) |
| [marked-hook-frontmatter](packages/hook-frontmatter) | `MarkdownHook` | A sequential hook to support frontmatter | [](packages/hook-frontmatter/changelog.md) |
| [marked-hook-layout](packages/hook-layout) | `HtmlHook` | A sequential hook that handles layouts | [](packages/hook-layout/changelog.md) |
## Contributing
We 💛 issues.
When committing, please conform to [the semantic-release commit standards](https://www.conventionalcommits.org/). Please install `commitizen` and the adapter globally, if you have not already.
```bash
npm i -g commitizen cz-conventional-changelog
```
Now you can use `git cz` or just `cz` instead of `git commit` when committing. You can also use `git-cz`, which is an alias for `cz`.
```bash
git add . && git cz
```