@san-siva/blogkit-md 0.2.4 → 0.2.6

package/README.md

@@ -1,44 +1,14 @@
 ---
 title: blogkit-md
-description: A Next.js tool that converts standard markdown files into rendered blog posts for `@san-siva/blogkit`.
+description: A React component library that converts markdown files into rendered blog posts for `@san-siva/blogkit`.
 ---
 
-A Next.js tool that converts standard markdown files into rendered blog posts for [`@san-siva/blogkit`](https://blogkit.santhoshsiva.dev).
+A React component library that converts markdown files into rendered blog posts for [`@san-siva/blogkit`](https://blogkit.santhoshsiva.dev).
 
-> This README is automatically rendered as a live demo at [blogkit-md.santhoshsiva.dev](https://blogkit-md.santhoshsiva.dev)
+> Live preview of this README is available here [blogkit-md.santhoshsiva.dev](https://blogkit-md.santhoshsiva.dev)
 
 ## Getting started
 
-```bash
-git clone https://github.com/san-siva/blogkit-md.git
-npm install
-```
-
-### Dev server
-
-```bash
-npm run dev                          # uses data/test.md by default
-npm run dev -- --file=data/my-post.md  # specify a markdown file
-```
-
-The dev server watches the markdown file for changes and auto-reloads the browser via HMR.
-
-### Build
-
-```bash
-npm run build
-npm run start
-```
-
-### Lint
-
-```bash
-npm run lint   # check
-npm run fix    # auto-fix
-```
-
-## Using BlogPost in your own Next.js app
-
 `blogkit-md` exposes a `BlogPost` server component you can drop into any Next.js project.
 
 ### Install
@@ -47,20 +17,6 @@ npm run fix    # auto-fix
 npm install @san-siva/blogkit-md
 ```
 
-Or as a local package:
-
-```json
-"@san-siva/blogkit-md": "file:../blogkit-md"
-```
-
-Add it to `transpilePackages` in your `next.config.ts`:
-
-```ts
-const nextConfig = {
-	transpilePackages: ['@san-siva/blogkit-md'],
-};
-```
-
 ### Usage
 
 ```tsx

package/dist/index.d.mts

@@ -20,14 +20,13 @@ declare const MarkdownSections: ({ rendered, }: {
     rendered: RenderedMarkdown;
 }) => React.ReactNode;
 
-type MarkdownFileResult = {
+type MarkdownFileResult = ({
     success: true;
     rendered: RenderedMarkdown;
-    frontmatter: Frontmatter;
-} | {
+} & Frontmatter) | {
     success: false;
     error: string;
 };
 declare const readMarkdownFile: (filePath: string | undefined) => Promise<MarkdownFileResult>;
 
-export { BlogPost, MarkdownSections, readMarkdownFile };
+export { BlogPost, type Frontmatter, MarkdownSections, readMarkdownFile };

package/dist/index.js

@@ -404,7 +404,7 @@ var readMarkdownFile = async (filePath) => {
   }
   const { ast, frontmatter } = parseMarkdown(content);
   const rendered = renderMarkdownAst(ast);
-  return { success: true, rendered, frontmatter };
+  return __spreadValues({ success: true, rendered }, frontmatter);
 };
 export {
   BlogPost_default as BlogPost,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@san-siva/blogkit-md",
-	"version": "0.2.4",
+	"version": "0.2.6",
 	"description": "Converts markdown files into JSX blog posts for Blogkit",
 	"main": "./dist/index.js",
 	"exports": {

package/src/hooks/readMarkdownFile.ts

@@ -7,7 +7,7 @@ import type { RenderedMarkdown } from '../utils/renderMarkdown';
 import { renderMarkdownAst } from '../utils/renderMarkdown';
 
 type MarkdownFileResult =
-	| { success: true; rendered: RenderedMarkdown; frontmatter: Frontmatter }
+	| ({ success: true; rendered: RenderedMarkdown } & Frontmatter)
 	| { success: false; error: string };
 
 export const readMarkdownFile = async (
@@ -38,5 +38,5 @@ export const readMarkdownFile = async (
 	const { ast, frontmatter } = parseMarkdown(content);
 	const rendered = renderMarkdownAst(ast);
 
-	return { success: true, rendered, frontmatter };
+	return { success: true, rendered, ...frontmatter };
 };

package/src/index.ts

@@ -1,3 +1,4 @@
 export { default as BlogPost } from './components/BlogPost';
 export { readMarkdownFile } from './hooks/readMarkdownFile';
+export type { Frontmatter } from './utils/parseMarkdown';
 export { MarkdownSections } from './utils/renderMarkdown';