feat: astro document

Author: ziqiangai

.gitignore

@@ -3,3 +3,5 @@
 logs/
 /packages/core/dist/
 /packages/**/node_modules/
+.vscode/
+.DS_Store

document/.gitignore

@@ -0,0 +1,21 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store

document/README.md

@@ -0,0 +1,54 @@
+# Starlight Starter Kit: Basics
+
+[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+
+```
+npm create astro@latest -- --template starlight
+```
+
+[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
+[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+
+> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
+
+## 🚀 Project Structure
+
+Inside of your Astro + Starlight project, you'll see the following folders and files:
+
+```
+.
+├── public/
+├── src/
+│   ├── assets/
+│   ├── content/
+│   │   ├── docs/
+│   │   └── config.ts
+│   └── env.d.ts
+├── astro.config.mjs
+├── package.json
+└── tsconfig.json
+```
+
+Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
+
+Images can be added to `src/assets/` and embedded in Markdown with a relative link.
+
+Static assets, like favicons, can be placed in the `public/` directory.
+
+## 🧞 Commands
+
+All commands are run from the root of the project, from a terminal:
+
+| Command                   | Action                                           |
+| :------------------------ | :----------------------------------------------- |
+| `npm install`             | Installs dependencies                            |
+| `npm run dev`             | Starts local dev server at `localhost:4321`      |
+| `npm run build`           | Build your production site to `./dist/`          |
+| `npm run preview`         | Preview your build locally, before deploying     |
+| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |
+| `npm run astro -- --help` | Get help using the Astro CLI                     |
+
+## 👀 Want to learn more?
+
+Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

document/astro.config.mjs

@@ -0,0 +1,26 @@
+import starlight from '@astrojs/starlight'
+import { defineConfig } from 'astro/config'
+import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc'
+
+export default defineConfig({
+	integrations: [
+		starlight({
+			plugins: [
+				// Generate the documentation.
+				starlightTypeDoc({
+					entryPoints: ['../packages/core/src/index.ts'],
+					tsconfig: '../packages/core/tsconfig.json',
+				}),
+			],
+			sidebar: [
+				{
+					label: 'Guides',
+					items: [{ label: 'Example Guide', link: '/guides/example/' }],
+				},
+				// Add the generated sidebar group to the sidebar.
+				typeDocSidebarGroup,
+			],
+			title: 'My Docs',
+		}),
+	],
+})

document/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "document",
+  "type": "module",
+  "version": "0.0.1",
+  "scripts": {
+    "dev": "astro dev",
+    "start": "astro dev",
+    "build": "astro check && astro build",
+    "preview": "astro preview",
+    "astro": "astro"
+  },
+  "dependencies": {
+    "@astrojs/check": "^0.7.0",
+    "@astrojs/starlight": "^0.24.5",
+    "astro": "^4.10.2",
+    "sharp": "^0.32.5",
+    "starlight-typedoc": "^0.13.0",
+    "typedoc": "^0.26.3",
+    "typedoc-plugin-markdown": "^4.1.1",
+    "typescript": "^5.5.3"
+  }
+}

document/public/favicon.svg

@@ -0,0 +1,6 @@
+import { defineCollection } from 'astro:content';
+import { docsSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+	docs: defineCollection({ schema: docsSchema() }),
+};

document/src/assets/houston.webp

@@ -0,0 +1,18 @@
+---
+editUrl: false
+next: false
+prev: false
+title: "core"
+---
+
+## Classes
+
+- [CollaGrid](/api/classes/collagrid/)
+
+## Interfaces
+
+- [CollaGridOption](/api/interfaces/collagridoption/)
+
+## Functions
+
+- [createCollaGrid](/api/functions/createcollagrid/)

document/src/content/config.ts

@@ -0,0 +1,42 @@
+---
+editUrl: false
+next: false
+prev: false
+title: "CollaGrid"
+---
+
+## Constructors
+
+### new CollaGrid()
+
+> **new CollaGrid**(`option`): [`CollaGrid`](/api/classes/collagrid/)
+
+#### Parameters
+
+• **option**: [`CollaGridOption`](/api/interfaces/collagridoption/)
+
+#### Returns
+
+[`CollaGrid`](/api/classes/collagrid/)
+
+#### Defined in
+
+[index.ts:21](https://github.com/collagrid/Collagrid/blob/3ab53a2129dce66dabded680a42e74d77a46d39a/packages/core/src/index.ts#L21)
+
+## Methods
+
+### mount()
+
+> **mount**(`domId`): `void`
+
+#### Parameters
+
+• **domId**: `string`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[index.ts:44](https://github.com/collagrid/Collagrid/blob/3ab53a2129dce66dabded680a42e74d77a46d39a/packages/core/src/index.ts#L44)