JSPM

@goulvenclech/astropi

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q29068F
  • License MIT

Build beautiful and accessible API documentations with Astro 🪐

Package Exports

  • @goulvenclech/astropi
  • @goulvenclech/astropi/index.ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@goulvenclech/astropi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Astropi - Core package 🪐

This package contains the core of Astropi, including the components, styles, and utilities that power the project.

👀 Understanding Astropi

  • Astropi is not a simple "starter" template, but a Astro Integration . Read more about it and see the main astropi() function in -> packages/astropi/index.ts.

  • Astropi provides a few zod schemas to help you build your documentation, and to generate pages from the user configuration. You can find them in -> packages/astropi/utils/collections.ts.

  • Astropi comes with a few components and pages to help you build your documentation. You can find them in -> packages/astropi/components/ & packages/astropi/layouts/ & packages/astropi/pages/.

  • Astropi exposes the user configuration trough a Vite plugin with a virtual module. You can find it in -> packages/astropi/utils/virtual-user-config.ts.