nhcarrigan/docs
2
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: convert to an astro application (!9)

Browse Source 
Reviewed-on: https://codeberg.org/nhcarrigan/docs/pulls/9
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit is contained in:
Naomi Carrigan
2024-08-23 23:49:24 +00:00
committed by Naomi the Technomancer
parent 2898736099
commit 4cc44ae423
43 changed files with 4727 additions and 1368 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -1,29 +1,47 @@
# General Documentation
# Astro Starter Kit: Minimal
Documentation for my smaller projects.
```sh
npm create astro@latest -- --template minimal
```
## Live Version
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
This page is currently deployed. [View the live website.](https://docs.nhcarrigan.com)
> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
## Feedback and Bugs
## πŸš€ Project Structure
If you have feedback or a bug report, please feel free to open a GitHub issue!
Inside of your Astro project, you'll see the following folders and files:
## Contributing
```text
/
β”œβ”€β”€ public/
β”œβ”€β”€ src/
β”‚ └── pages/
β”‚ └── index.astro
└── package.json
```
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.
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
## Code of Conduct
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Before interacting with our community, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
Any static assets, like images, can be placed in the `public/` directory.
## License
## 🧞 Commands
This software is licensed under our [global software license](https://docs.nhcarrigan.com/#/license).
All commands are run from the root of the project, from a terminal:
Copyright held by Naomi Carrigan.
| 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 astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
## Contact
## πŸ‘€ Want to learn more?
We may be contacted through our [Chat Server](http://chat.nhcarrigan.com) or via `contact@nhcarrigan.com`.
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).