@mintlify/astro 0.1.8 → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mintlify, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,16 +1,18 @@
 # @mintlify/astro
 
-Mintlify integration for Astro. This package syncs Mintlify-style docs content into Astro content collections and provides MDX components for rendering docs pages.
+Mintlify integration for [Astro](https://astro.build). Syncs Mintlify-style docs content into Astro content collections and provides MDX components for rendering docs pages.
 
 ## Install
 
 ```bash
-npm install @mintlify/components
+npm install @mintlify/astro
 ```
 
+Peer dependencies: `astro`, `@astrojs/react`, `@astrojs/mdx`, `@mintlify/components`, and `react`.
+
 ## Usage
 
-### 1) Configure Astro integration
+### 1. Configure the Astro integration
 
 ```ts
 // astro.config.mjs
@@ -24,28 +26,38 @@ export default defineConfig({
 });
 ```
 
-### 2) Use MDX components in docs page
+### 2. Use MDX components in a docs page
 
 ```astro
 ---
 import { render } from 'astro:content';
 import { components } from '@mintlify/astro/components';
 ---
+
 <Content components={components} />
 ```
 
 ## Expected docs structure
 
-- `./docs/docs.json`
-- `./docs/**/*.mdx`
-- `./docs/snippets/*` (optional)
-- supported static assets anywhere in `./docs/**` (`.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.svg`, `.ico`, `.mp4`, `.webm`, `.mp3`, `.wav`, `.css`, `.woff`, `.woff2`, `.ttf`, `.eot`)
+- `./docs/docs.json` — navigation and site configuration
+- `./docs/**/*.mdx` — page content
+- `./docs/snippets/*` — reusable content snippets (optional)
+- Static assets anywhere in `./docs/**` (`.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.svg`, `.ico`, `.mp4`, `.webm`, `.mp3`, `.wav`, `.css`, `.woff`, `.woff2`, `.ttf`, `.eot`)
+
+At build setup time, the integration generates files under `.mintlify/`:
+
+| Directory | Contents |
+|-----------|----------|
+| `.mintlify/docs/` | Synced page content |
+| `.mintlify/components/` | Extracted React components |
+| `.mintlify/static/` | Static assets from docs |
+
+These are generated build artifacts and should not be edited manually.
+
+## Contributing
 
-At build setup time, the integration generates:
+See [CONTRIBUTING.md](./CONTRIBUTING.md) and [DEVELOPMENT.md](./DEVELOPMENT.md).
 
-- `.mintlify/docs/**/*` (synced page content)
-- `.mintlify/components/**/*` (extracted React components)
-- `.mintlify/static/**/*` (static assets from docs)
-- `.mintlify/generated/favicons.json` (when favicon is configured)
+## License
 
-These directories are generated build artifacts and should not be edited manually.
+[MIT](./LICENSE)

package/dist/helpers.js

@@ -1,4 +1,4 @@
-import { divisions } from '@mintlify/validation';
+import { divisions, } from '@mintlify/validation';
 export function isNavPage(entry) {
     return 'href' in entry && 'title' in entry;
 }
@@ -140,7 +140,7 @@ export function getFooterPages(entries, currentPath) {
     };
 }
 function flattenPages(entries) {
-    return entries.flatMap((x) => isNavGroup(x) ? flattenPages(x.pages) : [x]);
+    return entries.flatMap((x) => (isNavGroup(x) ? flattenPages(x.pages) : [x]));
 }
 /**
  * Finds the group label that contains the given path.

package/dist/index.js

@@ -11,6 +11,7 @@ import { readDocsConfig } from './utils/read-docs-config.js';
 import { readPageContent } from './utils/read-page-content.js';
 import { createStaticAssetMiddleware } from './utils/serve-docs-assets.js';
 import { writePageContent } from './utils/write-page-content.js';
+import { writeRawMd } from './utils/write-raw-md.js';
 export { readDocsConfig } from './utils/read-docs-config.js';
 export function mintlify(options) {
     let docsDir;
@@ -38,22 +39,25 @@ export function mintlify(options) {
                 const docsConfig = await readDocsConfig(docsDir);
                 const pagePaths = getAllPathsInDocsNav(docsConfig.navigation);
                 logger.info(`Found ${pagePaths.length} pages to sync`);
-                await Promise.all(pagePaths.map(async (pagePath) => {
-                    try {
-                        const { content, slug } = await readPageContent(pagePath, docsDir);
-                        await writePageContent({
-                            content,
-                            slug,
-                            contentDir,
-                            componentsDir,
-                            userComponents,
-                            snippets,
-                        });
-                    }
-                    catch (error) {
-                        logger.warn(`Failed to read content for ${pagePath}: ${error}`);
-                    }
-                }));
+                await Promise.all([
+                    writeRawMd(pagePaths, docsDir, staticDir),
+                    ...pagePaths.map(async (pagePath) => {
+                        try {
+                            const { content, slug } = await readPageContent(pagePath, docsDir);
+                            await writePageContent({
+                                content,
+                                slug,
+                                contentDir,
+                                componentsDir,
+                                userComponents,
+                                snippets,
+                            });
+                        }
+                        catch (error) {
+                            logger.warn(`Failed to read content for ${pagePath}: ${error}`);
+                        }
+                    }),
+                ]);
                 logger.info(`Synced ${pagePaths.length} pages`);
             },
             'astro:server:setup': ({ server }) => {

package/dist/utils/serve-docs-assets.js

@@ -14,7 +14,9 @@ export function createStaticAssetMiddleware(staticDir) {
         catch {
             return next();
         }
-        const relativePath = pathname.startsWith('/') ? pathname.slice(1) : pathname;
+        const relativePath = pathname.startsWith('/')
+            ? pathname.slice(1)
+            : pathname;
         if (!relativePath)
             return next();
         if (!isSupportedStaticAsset(relativePath))

package/dist/utils/static-assets.js

@@ -16,6 +16,7 @@ const SUPPORTED_STATIC_ASSETS = {
     '.woff2': 'font/woff2',
     '.ttf': 'font/ttf',
     '.eot': 'application/vnd.ms-fontobject',
+    '.md': 'text/plain',
 };
 export function isSupportedStaticAsset(pathname) {
     const extension = posix.extname(pathname).toLowerCase();

package/dist/utils/write-raw-md.d.ts

@@ -0,0 +1 @@
+export declare function writeRawMd(pagePaths: string[], docsDir: string, outputDir: string): Promise<void>;

package/dist/utils/write-raw-md.js

@@ -0,0 +1,34 @@
+import { mkdir, readFile, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { parseFrontmatter } from '@mintlify/common';
+export async function writeRawMd(pagePaths, docsDir, outputDir) {
+    await Promise.all(pagePaths.map(async (pagePath) => {
+        let content;
+        try {
+            content = await readFile(join(docsDir, `${pagePath}.mdx`));
+        }
+        catch {
+            try {
+                content = await readFile(join(docsDir, `${pagePath}.md`));
+            }
+            catch {
+                return;
+            }
+        }
+        let filePath;
+        if (pagePath === 'index') {
+            filePath = join(outputDir, 'index.md');
+        }
+        else {
+            const parts = pagePath.split('/');
+            const fileName = parts.pop() + '.md';
+            const dirPath = join(outputDir, ...parts);
+            if (parts.length > 0) {
+                await mkdir(dirPath, { recursive: true });
+            }
+            filePath = join(dirPath, fileName);
+        }
+        const { body } = parseFrontmatter(content.toString());
+        await writeFile(filePath, body);
+    }));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/astro",
-  "version": "0.1.8",
+  "version": "1.0.0",
   "description": "Mintlify integration for Astro",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -26,10 +26,19 @@
   "scripts": {
     "prepare": "npm run build",
     "build": "tsc",
-    "type": "tsc --noEmit"
+    "type": "tsc --noEmit",
+    "format": "prettier --write ."
   },
   "author": "Mintlify, Inc.",
-  "license": "ISC",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mintlify/astro.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mintlify/astro/issues"
+  },
+  "homepage": "https://github.com/mintlify/astro#readme",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -47,6 +56,7 @@
     "astro": "^5.17.1",
     "mdast": "^2.3.2",
     "mdast-util-mdx": "^3.0.0",
+    "prettier": "^3.8.1",
     "react": "^19.2.3",
     "react-dom": "^19.2.3",
     "typescript": "^5.9.3"