fct/docs
2024-07-30 20:21:38 -04:00
..
.vscode feat: initial release of fct 2024-07-07 00:32:06 -04:00
public feat: initial release of fct 2024-07-07 00:32:06 -04:00
src docs: update policy without store 2024-07-30 20:21:38 -04:00
.gitignore feat: initial release of fct 2024-07-07 00:32:06 -04:00
astro.config.mjs build: remove tailwindcss but add to docs 2024-07-07 01:10:38 -04:00
bun.lockb build: remove tailwindcss but add to docs 2024-07-07 01:10:38 -04:00
package.json build: remove tailwindcss but add to docs 2024-07-07 01:10:38 -04:00
postcss.config.mjs docs: add postcss.config.mjs 2024-07-07 04:12:36 -04:00
README.md feat: initial release of fct 2024-07-07 00:32:06 -04:00
tailwind.config.mjs build: remove tailwindcss but add to docs 2024-07-07 01:10:38 -04:00
tsconfig.json feat: initial release of fct 2024-07-07 00:32:06 -04:00

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 Starlights docs and/or read the Astro documentation.