@hagicode/hagilight 0.3.2-dev.57.1.ee1f17e → 0.3.2-dev.58.1.bee3693

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.
Files changed (2) hide show
  1. package/README.md +30 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,30 @@
1
+ # @hagicode/hagilight
2
+
3
+ Astro integrations and components for HagiCode sites without Starlight. Provides sitemap and `robots.txt` generation, optional localized RSS feeds and favicon, and a reusable SEO head component.
4
+
5
+ ## Install
6
+
7
+ ```sh
8
+ npm install @hagicode/hagilight astro
9
+ ```
10
+
11
+ Use a supported Astro version (`^6.0.7 || ^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 { hagilight, hagilightFavicon } from '@hagicode/hagilight/integration';
19
+
20
+ export default defineConfig({
21
+ site: 'https://example.com',
22
+ integrations: [hagilight(), hagilightFavicon()],
23
+ });
24
+ ```
25
+
26
+ `hagilight()` generates a sitemap and `robots.txt` when the site does not already provide them. Set an absolute HTTP(S) `site` URL. `hagilightFavicon()` adds the bundled icon unless the site already declares one.
27
+
28
+ For localized RSS, use `hagilightRss({ locales, getFeed: './src/rss-feed.ts' })` from the same `/integration` entry point; `getFeed` points to a project-root-relative module exporting a feed callback. Import `@hagicode/hagilight/SEOHead` for SEO metadata in an Astro page or layout.
29
+
30
+ See the [repository documentation](https://github.com/HagiCode-org/hagilight#readme) for RSS configuration, feed callback types, and integration behavior.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hagicode/hagilight",
3
- "version": "0.3.2-dev.57.1.ee1f17e",
3
+ "version": "0.3.2-dev.58.1.bee3693",
4
4
  "type": "module",
5
5
  "description": "Astro integrations and components for HagiCode sites",
6
6
  "repository": {
@@ -24,6 +24,7 @@
24
24
  "./SEOHead": "./SEOHead.astro"
25
25
  },
26
26
  "files": [
27
+ "README.md",
27
28
  "dist/**/*.js",
28
29
  "dist/**/*.d.ts",
29
30
  "*.astro",
@@ -38,7 +39,7 @@
38
39
  },
39
40
  "dependencies": {
40
41
  "@astrojs/sitemap": "^3.7.4",
41
- "@hagicode/hagilight-core": "0.3.2-dev.57.1.ee1f17e"
42
+ "@hagicode/hagilight-core": "0.3.2-dev.58.1.bee3693"
42
43
  },
43
44
  "keywords": [
44
45
  "astro-component",