8000 astal/docs at main · Aylur/astal · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History

docs

README.md

Astal Docs

This directory contains the Astal documentation and Library references.

Commands

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:5173
npm run build Build your production site to ./dist/
npm run preview Preview your build locally

Add your creation to the showcases page

  1. Add your image as a webp to public/showcase
  2. Add it to showcases/showcases.ts
    • src should be /showcase/your-name-optional-title.webp
    • url should point to the source code of the showcased widget/setup
    • author should be your name/nickname
.
├── public/showcase
│   └── your-name-optional-title.webp   # 1. add image
└── showcases/
    └── showcases.ts                    # 2. add information
0