Compile PDF and EPUB files from static Web assets.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 2.1 KiB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. # Astro Starter Kit: Minimal
  2. ```sh
  3. npm create astro@latest -- --template minimal
  4. ```
  5. [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
  6. [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
  7. [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
  8. > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
  9. ## 🚀 Project Structure
  10. Inside of your Astro project, you'll see the following folders and files:
  11. ```text
  12. /
  13. ├── public/
  14. ├── src/
  15. │ └── pages/
  16. │ └── index.astro
  17. └── package.json
  18. ```
  19. Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
  20. There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
  21. Any static assets, like images, can be placed in the `public/` directory.
  22. ## 🧞 Commands
  23. All commands are run from the root of the project, from a terminal:
  24. | Command | Action |
  25. | :------------------------ | :----------------------------------------------- |
  26. | `npm install` | Installs dependencies |
  27. | `npm run dev` | Starts local dev server at `localhost:4321` |
  28. | `npm run build` | Build your production site to `./dist/` |
  29. | `npm run preview` | Preview your build locally, before deploying |
  30. | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
  31. | `npm run astro -- --help` | Get help using the Astro CLI |
  32. ## 👀 Want to learn more?
  33. Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).