HTML documentation template used by API Genie.
(!) Ten pakiet dostarcza reuzywalnych komponentów do tworzenia ładnej dokumentacji API !
(!) Najlepiej współpracuje z API Genie i jego generatorem dokumentacji (polecenie generate doc html).
(!) Mozesz to robić na dwa sposoby:
(!) 1) z API Genie, kiedy to generujemy dokumentację (która składa się z konkretnych komponentów oraz gotowych juz stron). Plusem jest prostota a jednocześnie elastyczność. (!) 2) osobno. W tym przypadku uzywamy innego generatora (lub składamy konkretne komponenty oraz strony) do zbudowania konkretnych komponentów.
npm create astro@latest -- --template basics
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
Inside of your Astro project, you'll see the following folders and files:
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.json
Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, can be placed in the public/ directory.
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 |
Feel free to check our documentation or jump into our Discord server.