Skip to content

sgalcheung/starsquid

Repository files navigation

πŸ’œ starsquid ❀️

Starlight plugin to pull articles from Squidex(3rd-party API) to your documentation.

Screenshot of starsquid

origin discussion Pull main docs Content from 3rd-party API (a headless CMS) Β· withastro/starlight Β· Discussion #1790 (github.com)

🌠 Getting Started

Want to get started immediately? Check out the source code or check out the example to see the plugin in action.

πŸš€ Project Structure

.
β”œβ”€β”€ LICENSE
β”œβ”€β”€ README.md -> ./playground/README.md
β”œβ”€β”€ biome.json
β”œβ”€β”€ node_modules
β”œβ”€β”€ package.json
β”œβ”€β”€ packages
└── starsquid
    β”œβ”€β”€ CHANGELOG.md
    β”œβ”€β”€ README.md
    β”œβ”€β”€ astro.d.ts
    β”œβ”€β”€ dist
    β”œβ”€β”€ generated
    β”œβ”€β”€ node_modules
    β”œβ”€β”€ package.json
    β”œβ”€β”€ src
    β”œβ”€β”€ ts-to-zod.config.cjs
    β”œβ”€β”€ tsconfig.base.json
    β”œβ”€β”€ tsconfig.json
    └── tsup.config.ts
β”œβ”€β”€ playground
β”‚   β”œβ”€β”€ CHANGELOG.md
β”‚   β”œβ”€β”€ README.md
β”‚   β”œβ”€β”€ astro.config.mjs
β”‚   β”œβ”€β”€ codegen.ts
β”‚   β”œβ”€β”€ components.json
β”‚   β”œβ”€β”€ dist
β”‚   β”œβ”€β”€ generated
β”‚   β”œβ”€β”€ node_modules
β”‚   β”œβ”€β”€ package.json
β”‚   β”œβ”€β”€ public
β”‚   β”œβ”€β”€ src
β”‚   └── tsconfig.json
β”œβ”€β”€ pnpm-lock.yaml
β”œβ”€β”€ pnpm-workspace.yaml
β”œβ”€β”€ screenshot.gif
β”œβ”€β”€ screenshot.png
└── scripts
    β”œβ”€β”€ cmd
    β”œβ”€β”€ index.js
    β”œβ”€β”€ jsconfig.json
    β”œβ”€β”€ node_modules
    β”œβ”€β”€ package.json
    └── release.mjs

βš™οΈ Features

A Starlight plugin to server render contents, it is experment, more features are under development.

  • SSR render contents
  • Refresh(Inprogress)
  • Singleton See detail

Important

This package inspired from dewp. This README format inspired from starlight-blog.

Licensing

MIT Licensed. Made with ❀️ by Sgal Cheung.

About

πŸ’œA starlight🌟 website, backend with Squidex❀️.

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •