https://github.com/queen-raae/galleon-website

Website for Galleon Tools
https://github.com/queen-raae/galleon-website

Last synced: 3 months ago
JSON representation

Website for Galleon Tools

• Host: GitHub
• URL: https://github.com/queen-raae/galleon-website
• Owner: queen-raae
• Created: 2025-01-24T10:38:55.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-02-20T09:58:35.000Z (3 months ago)
• Last Synced: 2025-03-05T08:43:24.619Z (3 months ago)
• Language: JavaScript
• Homepage: https://galleon.tools/
• Size: 9.11 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Galleon Starter Kit: ...

[![Built with Galleon](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://galleon-tools.netlify.app/)

```

    script

```

[![Open in ...](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/tailwind)

[![Open with ...](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/tailwind)

[![Deploy to ...](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/tailwind)

[![Deploy with ...](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Ftailwind&project-name=my-starlight-docs&repository-name=my-starlight-docs)

> 🏴‍☠️ **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](https://galleon-tools.netlify.app/guides/example/), read [the Galleon documentation](https://galleon-tools.netlify.app/guides/example), or jump into the [Galleon’s ... server](https://galleon-tools.netlify.app/).