generated from nhcarrigan/template
docs: update README to standard template
This commit is contained in:
@@ -1,47 +1,29 @@
|
|||||||
# Astro Starter Kit: Minimal
|
# docs
|
||||||
|
|
||||||
```sh
|
Documentation for NHCarrigan projects.
|
||||||
npm create astro@latest -- --template minimal
|
|
||||||
```
|
|
||||||
|
|
||||||
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
|
## Live Version
|
||||||
[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
|
|
||||||
[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
|
|
||||||
|
|
||||||
> π§βπ **Seasoned astronaut?** Delete this file. Have fun!
|
This page is currently deployed. [View the live website.](https://docs.nhcarrigan.com)
|
||||||
|
|
||||||
## π Project Structure
|
## Feedback and Bugs
|
||||||
|
|
||||||
Inside of your Astro project, you'll see the following folders and files:
|
If you have feedback or a bug report, please [log a ticket on our forum](https://support.nhcarrigan.com).
|
||||||
|
|
||||||
```text
|
## Contributing
|
||||||
/
|
|
||||||
βββ public/
|
|
||||||
βββ src/
|
|
||||||
β βββ pages/
|
|
||||||
β βββ index.astro
|
|
||||||
βββ package.json
|
|
||||||
```
|
|
||||||
|
|
||||||
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
|
If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our [contributing guidelines](CONTRIBUTING.md) first.
|
||||||
|
|
||||||
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
|
## Code of Conduct
|
||||||
|
|
||||||
Any static assets, like images, can be placed in the `public/` directory.
|
Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
## π§ Commands
|
## License
|
||||||
|
|
||||||
All commands are run from the root of the project, from a terminal:
|
This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).
|
||||||
|
|
||||||
| Command | Action |
|
Copyright held by Naomi Carrigan.
|
||||||
| :------------------------ | :----------------------------------------------- |
|
|
||||||
| `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 astro ...` | Run CLI commands like `astro add`, `astro check` |
|
|
||||||
| `npm run astro -- --help` | Get help using the Astro CLI |
|
|
||||||
|
|
||||||
## π Want to learn more?
|
## Contact
|
||||||
|
|
||||||
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via email at `contact@nhcarrigan.com`
|
||||||
|
|||||||
Reference in New Issue
Block a user