From ac7d751e8e67fac7cc44ce7b05df7e94245a915e Mon Sep 17 00:00:00 2001 From: sandypockets Date: Sun, 17 Dec 2023 18:58:31 -0500 Subject: [PATCH] Fix: Add homepage, Git, issues urls --- README.md | 11 ++++++++++- package.json | 10 +++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c876549..671547c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/package.json b/package.json index 50619cf..b5d1276 100644 --- a/package.json +++ b/package.json @@ -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", @@ -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",