Chore: Set up build, examples, styling

.github/workflows/ci.yml

@@ -18,4 +18,4 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm cache clean --force
       - run: npm ci
-      - run: npm run test
+      - run: npm run test

.npmignore

@@ -1,5 +1,7 @@
 __tests__/
+demo/
 example/
+examples/
 docs/
 src/
 .babelrc

.prettierignore

@@ -8,4 +8,14 @@ node_modules/
 .git/
 .vscode/
 .idea/
-coverage/
+coverage/
+example/.*
+example/.*
+example/node_modules/
+example/*.log
+example/*.tmp
+example/*.config.js
+example/package-lock.json
+example/package.json
+example/README.md
+example/postcss.config.js

README.md

@@ -9,18 +9,32 @@ Use the all-in-one `processMarkdown` function to format your markdown into HTML,
 - `remark-html`: `^16.0.1`
 - `rehype-stringify`: `^10.0.0`
 - `remark-rehype`: `^11.0.0`
+- `rehype-raw`: `^7.0.0`
 
 ## How does it work
 `epic-remark` first uses `remark` and `remark-html` to convert your initial markdown to HTML. Then, `remark-gfm` is applied to enable the use of GitHub-flavoured markdown (tables, strikethrough, etc). At this point, the HTML is in a special `remark` AST (Abstract Syntax Tree). While it is possible to traverse and modify the tree, it can have some unexpected results. To create a more predictable environment, `epic-remark` uses `remark-rehype` to convert the `remark` AST to an easily adjustable HAST (HTML Abstract Syntax Tree). 
 
 `epic-remark` then runs any of the custom `epic-remark` plugins you've enabled, serializes the newly modified HAST using `rehype-stringify`, and returns the HTML content back to you, ready to display on your frontend.
 
-## Plugins
+# Plugins
 
-* `processMarkdown` - Converts markdown to HTML and returns it. Uses configurable options object to enable other plugins during execution.
-* `addHeadingIds` - Adds an `id` attribute to all headings. The `id` will be the same as the heading's inner text. 
-* `wrapElements` - Wraps all specified elements in a `div` with a class. This allows for easier styling of elements like tables and images which often need containers. 
-* `addTableOfContents` - Gathers headings from content and creates a table of contents. Table of contents can be automatically prepended to the content, or returned in a separate object. 
+## `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.
+
+## `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.
+
+## `wrapElements`
+Provides the ability to wrap specified HTML elements in a div with a customizable class. By default, img and table tags are wrapped in divs with classes `epic-remark-image` and `epic-remark-table`, respectively. Users can extend or override these defaults using the wrapConfig option in processMarkdown, allowing for more granular control over the styling and layout of elements.
+
+## `addTableOfContents`
+Generates a table of contents based on the document's headings. Users can configure this plugin to either prepend the table of contents directly into the content or return it as a separate HTML string. This plugin enhances document structure and user navigation.
+
+## `calculateReadingTime`
+Estimates the reading time of the provided markdown content. The calculation is based on a standard words-per-minute metric, which can be adjusted via options. The reading time is returned in minutes, offering a quick overview of the content length.
+
+### Notes
+Processed markdown always returns auto-linked URLs. This means that if you have a URL in your markdown, it will be converted to a clickable link. 
 
 ## License
 MIT. See [license.md](LICENSE.md)

example/.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

example/README.md

@@ -0,0 +1,40 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.js`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

example/jsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./*"]
+    }
+  }
+}

example/next.config.js

@@ -0,0 +1,6 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+};
+
+module.exports = nextConfig;