@se-studio/markdown-renderer 1.0.109 → 1.0.112

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @se-studio/markdown-renderer
 
+## 1.0.112
+
+### Patch Changes
+
+- Version bump: patch for changed packages
+- Updated dependencies
+  - @se-studio/contentful-rest-api@1.0.155
+  - @se-studio/core-data-types@1.0.148
+
+## 1.0.111
+
+### Patch Changes
+
+- Version bump: patch for changed packages
+- Updated dependencies
+  - @se-studio/contentful-rest-api@1.0.154
+  - @se-studio/core-data-types@1.0.147
+
+## 1.0.110
+
+### Patch Changes
+
+- Version bump: patch for changed packages
+- Updated dependencies
+  - @se-studio/contentful-rest-api@1.0.153
+  - @se-studio/core-data-types@1.0.146
+
 ## 1.0.109
 
 ### Patch Changes

package/docs/llms.md

@@ -0,0 +1,102 @@
+# @se-studio/markdown-renderer — LLM Reference
+
+Converts Contentful CMS entries to Markdown. Used primarily for search indexing and LLM ingestion pipelines. Also generates `llms.txt` site indexes per the llmstxt.org spec.
+
+## MarkdownConverter — convert a single entry
+
+```ts
+import { MarkdownConverter } from '@se-studio/markdown-renderer';
+
+const converter = new MarkdownConverter({
+  contentfulConfig,   // ContentfulConfig from @se-studio/contentful-rest-api
+  urlCalculators,     // UrlCalculators — functions to build hrefs from slugs
+});
+
+// Convert a page, article, or person to Markdown
+const markdown = await converter.convert({ type: 'page', slug: 'home' });
+// Returns string of Markdown, or null if not found
+```
+
+## MarkdownExporter — export all content
+
+```ts
+import { MarkdownExporter } from '@se-studio/markdown-renderer';
+
+const exporter = new MarkdownExporter({
+  contentfulConfig,
+  urlCalculators,
+});
+
+// Fetch raw content data for a specific entry
+const contentData = await exporter.fetchContent('page', 'home', { preview: false });
+
+// Export all pages/articles to Markdown files (used for static export)
+await exporter.exportAll({ outputDir: './public/markdown' });
+```
+
+## LLMs.txt Generation
+
+Generates a machine-readable site index in the llmstxt.org format:
+
+```ts
+import { generateLlmsTxt, generateMarkdownIndex } from '@se-studio/markdown-renderer';
+
+// Generate llms.txt content (links to all markdown pages)
+const llmsTxt = generateLlmsTxt({
+  title: 'My Site',
+  description: 'Site description',
+  links: markdownLinks,
+});
+
+// Generate a markdown index of all content
+const index = generateMarkdownIndex({
+  pages: allPageLinks,
+  articles: allArticleLinks,
+  urlCalculators,
+});
+```
+
+## URL Builder Helpers
+
+```ts
+import { buildMarkdownLinksFromAppLinks, toMarkdownUrl } from '@se-studio/markdown-renderer';
+
+// Convert a page/article href to a markdown URL
+const mdUrl = toMarkdownUrl('/blog/my-post'); // → '/markdown/blog/my-post'
+
+// Build markdown link list from Contentful link arrays
+const links = buildMarkdownLinksFromAppLinks({
+  pageLinks: allPageLinks,
+  articleLinks: allArticleLinks,
+  urlCalculators,
+});
+```
+
+## Markdown API Routes (Next.js)
+
+```ts
+import { resolveMarkdownParams } from '@se-studio/markdown-renderer';
+
+// In app/api/markdown/[...params]/route.ts:
+export async function GET(request: Request, { params }: { params: { params: string[] } }) {
+  const { type, slug } = resolveMarkdownParams(params.params);
+  // type: 'page' | 'article' | etc.
+  // slug: the content slug
+}
+```
+
+## ContentData Type
+
+```ts
+import type { ContentData } from '@se-studio/markdown-renderer';
+
+// Used internally by both MarkdownConverter and the search package
+// Contains the raw fetched content + extracted text
+```
+
+## When to Use
+
+- **Search indexing**: `MarkdownExporter.fetchContent` is called by `@se-studio/search`'s `rebuildSearchIndex`
+- **LLM ingestion**: use `MarkdownConverter.convert` to turn CMS pages into readable Markdown
+- **Static exports**: expose `/markdown/*` routes so LLMs can crawl the site as Markdown
+- **llms.txt**: expose `/llms.txt` with `generateLlmsTxt` for llmstxt.org discovery

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@se-studio/markdown-renderer",
-  "version": "1.0.109",
+  "version": "1.0.112",
   "description": "Markdown renderer for Contentful content",
   "repository": {
     "type": "git",
@@ -23,14 +23,15 @@
   },
   "files": [
     "dist",
-    "*.md"
+    "*.md",
+    "docs"
   ],
   "dependencies": {
     "@contentful/rich-text-types": "^17.2.7",
     "html-entities": "^2.6.0",
     "js-yaml": "^4.1.1",
-    "@se-studio/contentful-rest-api": "1.0.152",
-    "@se-studio/core-data-types": "1.0.145"
+    "@se-studio/contentful-rest-api": "1.0.155",
+    "@se-studio/core-data-types": "1.0.148"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.15",