Skip to content

Commit

Permalink
Fix: Add homepage, Git, issues urls
Browse files Browse the repository at this point in the history
  • Loading branch information
sandypockets committed Dec 17, 2023
1 parent 1821119 commit ac7d751
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@

Use the all-in-one `processMarkdown` function to format your markdown into HTML, or import the custom plugins working behind the scenes one-by-one to mix your own flavour of Markdown HTML.

![npm bundle size](https://img.shields.io/bundlephobia/minzip/epic-remark)
![npm bundle size](https://img.shields.io/bundlephobia/min/epic-remark)
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/sandypockets/epic-remark/ci.yml)
![GitHub issues](https://img.shields.io/github/issues/sandypockets/epic-remark)
![GitHub pull requests](https://img.shields.io/github/issues-pr/sandypockets/epic-remark)
![npm](https://img.shields.io/npm/dt/epic-remark)
![npm](https://img.shields.io/npm/dw/epic-remark)
![NPM](https://img.shields.io/npm/l/epic-remark)

## Currently supported frameworks:
* Next.js
* Nuxt.js
Expand Down Expand Up @@ -81,7 +90,7 @@ See the [documentation](DOCUMENTATION.md) for more details on each option.
# Plugins

## `processMarkdown`
The processMarkdown function is the core of` epic-remark`. It converts markdown to HTML, applying a range of configurable options to enable additional plugins during execution. It is the primary function you'll use, with other plugins augmenting its capabilities.
The processMarkdown function is the core of `epic-remark`. It converts markdown to HTML, applying a range of configurable options to enable additional plugins during execution. It is the primary function you'll use, with other plugins augmenting its capabilities.

## `addHeadingIds`
Automatically adds an id attribute to all headings (h1 to h6). The id value mirrors the heading's text, transformed into a URL-friendly format. This plugin is ideal for creating anchor links and improving navigability within documents.
Expand Down
10 changes: 9 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "epic-remark",
"version": "1.0.0",
"version": "1.0.1",
"description": "Epic Remark is an all-in-one markdown to HTML processor built on top of remark",
"main": "dist/index.cjs.js",
"module": "dist/index.esm.js",
Expand All @@ -26,6 +26,14 @@
],
"author": "sandypockets",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/sandypockets/epic-remark.git"
},
"bugs": {
"url": "https://github.com/sandypockets/epic-remark/issues"
},
"homepage": "https://github.com/sandypockets/epic-remark#readme",
"dependencies": {
"rehype-raw": "^7.0.0",
"rehype-stringify": "^10.0.0",
Expand Down

0 comments on commit ac7d751

Please sign in to comment.