@hagicode/hagilight-starlight 0.3.2-dev.57.1.ee1f17e → 0.4.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/README.md +32 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# @hagicode/hagilight-starlight
|
|
2
|
+
|
|
3
|
+
A Starlight plugin for HagiCode documentation sites. Adds a localized header and footer, language chooser, content-width toggle, custom 404 page, SEO metadata, RSS feeds, analytics, and AI-content disclosures.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install @hagicode/hagilight-starlight @astrojs/starlight astro
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Use Starlight `^0.42.4` and Astro `^7.3.5`. The matching `@hagicode/hagilight-core` version is installed as a dependency.
|
|
12
|
+
|
|
13
|
+
## Use
|
|
14
|
+
|
|
15
|
+
```js
|
|
16
|
+
// astro.config.mjs
|
|
17
|
+
import { defineConfig } from 'astro/config';
|
|
18
|
+
import starlight from '@astrojs/starlight';
|
|
19
|
+
import hagilight from '@hagicode/hagilight-starlight';
|
|
20
|
+
import { locales } from '@hagicode/hagilight-starlight/locales';
|
|
21
|
+
|
|
22
|
+
export default defineConfig({
|
|
23
|
+
site: 'https://docs.example.com',
|
|
24
|
+
integrations: [
|
|
25
|
+
starlight({ title: 'Docs', locales, plugins: [hagilight()] }),
|
|
26
|
+
],
|
|
27
|
+
});
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The plugin also exposes `@hagicode/hagilight-starlight/schema` for optional SEO frontmatter and individual Astro components such as `/Header` and `/MarkdownContent` for custom Starlight overrides. Configure features through the typed `HagilightStarlightOptions` passed to `hagilight()`.
|
|
31
|
+
|
|
32
|
+
See the [repository documentation](https://github.com/HagiCode-org/hagilight#readme) for schema setup and feature options.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hagicode/hagilight-starlight",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Starlight plugin and components for HagiCode documentation",
|
|
6
6
|
"repository": {
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
"./PromotoFooter": "./PromotoFooter.astro"
|
|
40
40
|
},
|
|
41
41
|
"files": [
|
|
42
|
+
"README.md",
|
|
42
43
|
"dist/**/*.js",
|
|
43
44
|
"dist/**/*.d.ts",
|
|
44
45
|
"*.astro",
|
|
@@ -47,7 +48,7 @@
|
|
|
47
48
|
"assets/*.png"
|
|
48
49
|
],
|
|
49
50
|
"dependencies": {
|
|
50
|
-
"@hagicode/hagilight-core": "0.
|
|
51
|
+
"@hagicode/hagilight-core": "0.4.0"
|
|
51
52
|
},
|
|
52
53
|
"peerDependencies": {
|
|
53
54
|
"@astrojs/starlight": "^0.42.4",
|