Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.64 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.64 KB

Galleon Starter Kit: ...

Built with Galleon

    script

Open in ... Open with ... Deploy to ... Deploy with ...

🏴‍☠️ Seasoned ... pirate? Delete this file. Have fun!

⛵ ... Structure

Inside of your ... + Galleon project, you'll see the following folders and files:

.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   └── content.config.ts
├── Galleon.config.mjs
├── package.json
├── tailwind.config.mjs
└── tsconfig.json

Galleon looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

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 Galleon ... Run CLI commands like Galleon add, Galleon check
npm run Galleon -- --help Get help using the Galleon CLI

👀 Want to learn more?

Check out Galleon’s docs, read the Galleon documentation, or jump into the Galleon’s ... server.