starlight-head
v0.0.1
Published
A Starlight plugin for easy to add <head> for your Starlight site
Downloads
4
Readme
starlight-head
A Starlight plugin for easy to add <head> for your Starlight site.
Installation
npm install -D starlight-headUsage
// astro.config.mjs
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import starlightHead from "starlight-head";
export default defineConfig({
integrations: [
starlight({
title: "My Docs",
plugins: [
starlightHead({
path: "./src/components/head.astro",
}),
],
}),
],
});// src/components/head.astro
---
---
<meta name="description" content="This is a description by starlight-head-plugin">
<script>
window.onload = function() {
console.log("Page loaded");
}
</script>It will be covert to Starlight config:
starlight({
head: [
{
tag: "meta",
attributes: {
name: "description",
content: "This is a description by starlight-head-plugin",
},
},
{
tag: "script",
content: 'window.onload = function() {\n\tconsole.log("Page loaded");\n}',
},
],
});Features
- [x] Add
<head>content to Starlight by.astrocomponent. - [ ] Support expressions in
.astrocomponent. - [ ] Supports importing variables from other files.
- [ ] Support add
<head>for certain page.
Configuration Reference
path (required)
type: string
A path to the file that contains the <head> content. Like ./src/components/head.astro.
License
MIT