History

github-actions[bot] ed51a3b525 chore: update versions		2024-02-14 14:10:47 +00:00
..
examples	update	2024-02-13 08:54:55 -08:00
lib	update	2024-02-13 08:54:55 -08:00
CHANGELOG.md	chore: update versions	2024-02-14 14:10:47 +00:00
LICENSE	Massive Repo Cleanup and organization	2024-02-14 05:17:01 -08:00
README.md	update render util readme	2024-02-13 02:41:27 -08:00
index.ts	New Package for HTML Content Rendering, and it works!	2024-02-13 02:20:31 -08:00
package.json	chore: update versions	2024-02-14 14:10:47 +00:00

README.md

Astro GhostCMS Content API HTML Processor

Render remote GhostCMS HTML in Astro with full control over the output.

Rendering Remote Content

The most basic function of astro-ghostcms-rendercontent is to convert a string of HTML to Astro friendly HTML. Use the GhostRender component.

---
import { GhostRender } from "@matthiesenxyz/astro-ghostcms-rendercontent";
---

<GhostRender content={post.html} />

Customization

GhostRender allows full control over the rendering of output. The components option allows you to replace a standard HTML element with a custom component.

---
import { GhostRender } from "@matthiesenxyz/astro-ghostcms-rendercontent";
import Title from '../components/Title.astro';
---

<!-- Render <h1> as custom <Title> component -->
<GhostRender content={post.html} components={{ h1: Title }} />

For examples on how to setup custom components check examples