45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
|
# jscodeshift docs
|
|||
|
|
|
|||
|
|
[](https://starlight.astro.build)
|
|||
|
|
|
|||
|
|
## 🚀 Project Structure
|
|||
|
|
|
|||
|
|
```
|
|||
|
|
.
|
|||
|
|
├── 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 |
|
|||
|
|
|:-----------------------|:-------------------------------------------------|
|
|||
|
|
| `yarn install` | Installs dependencies |
|
|||
|
|
| `yarn dev` | Starts local dev server at `localhost:4321` |
|
|||
|
|
| `yarn build` | Build your production site to `./dist/` |
|
|||
|
|
| `yarn preview` | Preview your build locally, before deploying |
|
|||
|
|
| `yarn astro ...` | Run CLI commands like `astro add`, `astro check` |
|
|||
|
|
| `yarn astro -- --help` | Get help using the Astro CLI |
|
|||
|
|
|
|||
|
|
## 👀 Want to learn more?
|
|||
|
|
|
|||
|
|
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build),
|
|||
|
|
or jump into the [Astro Discord server](https://astro.build/chat).
|