feat: initial release of fct
This commit is contained in:
commit
eb80cc5ec7
96 changed files with 6616 additions and 0 deletions
42
docs/README.md
Normal file
42
docs/README.md
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
# File Converter Tool Website
|
||||
|
||||
## Project Structure
|
||||
|
||||
You may see the following folders and files:
|
||||
|
||||
```
|
||||
.
|
||||
├── public/
|
||||
├── src/
|
||||
│ ├── assets/
|
||||
│ ├── content/
|
||||
│ │ ├── docs/
|
||||
│ │ └── config.ts
|
||||
│ └── env.d.ts
|
||||
├── astro.config.mjs
|
||||
├── package.json
|
||||
└── tsconfig.json
|
||||
```
|
||||
|
||||
Starlight 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 |
|
||||
| :------------------------ | :----------------------------------------------- |
|
||||
| `bun install` | Installs dependencies |
|
||||
| `bun run dev` | Starts local dev server at `localhost:4321` |
|
||||
| `bun run build` | Build your production site to `./dist/` |
|
||||
| `bun run preview` | Preview your build locally, before deploying |
|
||||
| `bun run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||
| `bun run astro -- --help` | Get help using the Astro CLI |
|
||||
|
||||
## External documentation
|
||||
|
||||
You may view [Starlight’s docs](https://starlight.astro.build/) and/or read [the Astro documentation](https://docs.astro.build).
|
||||
Loading…
Add table
Add a link
Reference in a new issue