@mintlify/astro 0.1.9 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +25 -14
- package/package.json +10 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Mintlify, Inc.
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
# @mintlify/astro
|
|
2
2
|
|
|
3
|
-
Mintlify integration for Astro.
|
|
3
|
+
Mintlify integration for [Astro](https://astro.build). Syncs Mintlify-style docs content into Astro content collections and provides MDX components for rendering docs pages.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install @mintlify/
|
|
8
|
+
npm install @mintlify/astro
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
Peer dependencies: `astro`, `@astrojs/react`, `@astrojs/mdx`, `@mintlify/components`, and `react`.
|
|
12
|
+
|
|
11
13
|
## Usage
|
|
12
14
|
|
|
13
|
-
### 1
|
|
15
|
+
### 1. Configure the Astro integration
|
|
14
16
|
|
|
15
17
|
```ts
|
|
16
18
|
// astro.config.mjs
|
|
@@ -24,7 +26,7 @@ export default defineConfig({
|
|
|
24
26
|
});
|
|
25
27
|
```
|
|
26
28
|
|
|
27
|
-
### 2
|
|
29
|
+
### 2. Use MDX components in a docs page
|
|
28
30
|
|
|
29
31
|
```astro
|
|
30
32
|
---
|
|
@@ -37,16 +39,25 @@ import { components } from '@mintlify/astro/components';
|
|
|
37
39
|
|
|
38
40
|
## Expected docs structure
|
|
39
41
|
|
|
40
|
-
- `./docs/docs.json`
|
|
41
|
-
- `./docs/**/*.mdx`
|
|
42
|
-
- `./docs/snippets/*` (optional)
|
|
43
|
-
-
|
|
42
|
+
- `./docs/docs.json` — navigation and site configuration
|
|
43
|
+
- `./docs/**/*.mdx` — page content
|
|
44
|
+
- `./docs/snippets/*` — reusable content snippets (optional)
|
|
45
|
+
- Static assets anywhere in `./docs/**` (`.png`, `.jpg`, `.jpeg`, `.gif`, `.webp`, `.svg`, `.ico`, `.mp4`, `.webm`, `.mp3`, `.wav`, `.css`, `.woff`, `.woff2`, `.ttf`, `.eot`)
|
|
46
|
+
|
|
47
|
+
At build setup time, the integration generates files under `.mintlify/`:
|
|
48
|
+
|
|
49
|
+
| Directory | Contents |
|
|
50
|
+
|-----------|----------|
|
|
51
|
+
| `.mintlify/docs/` | Synced page content |
|
|
52
|
+
| `.mintlify/components/` | Extracted React components |
|
|
53
|
+
| `.mintlify/static/` | Static assets from docs |
|
|
54
|
+
|
|
55
|
+
These are generated build artifacts and should not be edited manually.
|
|
56
|
+
|
|
57
|
+
## Contributing
|
|
44
58
|
|
|
45
|
-
|
|
59
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md) and [DEVELOPMENT.md](./DEVELOPMENT.md).
|
|
46
60
|
|
|
47
|
-
|
|
48
|
-
- `.mintlify/components/**/*` (extracted React components)
|
|
49
|
-
- `.mintlify/static/**/*` (static assets from docs)
|
|
50
|
-
- `.mintlify/generated/favicons.json` (when favicon is configured)
|
|
61
|
+
## License
|
|
51
62
|
|
|
52
|
-
|
|
63
|
+
[MIT](./LICENSE)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/astro",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "Mintlify integration for Astro",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -30,7 +30,15 @@
|
|
|
30
30
|
"format": "prettier --write ."
|
|
31
31
|
},
|
|
32
32
|
"author": "Mintlify, Inc.",
|
|
33
|
-
"license": "
|
|
33
|
+
"license": "MIT",
|
|
34
|
+
"repository": {
|
|
35
|
+
"type": "git",
|
|
36
|
+
"url": "https://github.com/mintlify/astro.git"
|
|
37
|
+
},
|
|
38
|
+
"bugs": {
|
|
39
|
+
"url": "https://github.com/mintlify/astro/issues"
|
|
40
|
+
},
|
|
41
|
+
"homepage": "https://github.com/mintlify/astro#readme",
|
|
34
42
|
"publishConfig": {
|
|
35
43
|
"access": "public",
|
|
36
44
|
"registry": "https://registry.npmjs.org/"
|