auxolotl/docs-site
21
0
Fork 0
Code Issues Pull requests 1 Actions Packages Projects Releases Activity
A static site for viewing the wiki https://docs.auxolotl.org
3 commits 2 branches 0 tags 305 KiB
TypeScript 83.6%
Astro 12.4%
Nix 2.2%
JavaScript 1.3%
CSS 0.5%
Go to file
Skyler Grey 26b25a6cb6
feat: Add astro config 
We're basing this off the https://docs.astro.build/en/guides/markdown-content/#markdown-plugins
section of the astro docs, as well as some other remark information. We
have disabled XSS protection early in the rendering pipeline due to a
later sanitization step. This is mentioned on the remark docs and we have
tested it with some basic XSS examples
2024-05-17 00:05:57 +00:00
.vscode feat: Add project configuration 2024-05-17 00:03:19 +00:00
.envrc feat: Add project configuration 2024-05-17 00:03:19 +00:00
.gitignore feat: Add project configuration 2024-05-17 00:03:19 +00:00
.gitmodules feat: Add project configuration 2024-05-17 00:03:19 +00:00
astro.config.mjs feat: Add astro config 2024-05-17 00:05:57 +00:00
bun.lockb feat: Add project configuration 2024-05-17 00:03:19 +00:00
flake.lock feat: Add project configuration 2024-05-17 00:03:19 +00:00
flake.nix feat: Add project configuration 2024-05-17 00:03:19 +00:00
package.json feat: Add project configuration 2024-05-17 00:03:19 +00:00
README.md feat: Add project configuration 2024-05-17 00:03:19 +00:00
tsconfig.json feat: Add project configuration 2024-05-17 00:03:19 +00:00

README.md

Astro Starter Kit: Minimal

npm create astro@latest -- --template minimal

Open in StackBlitz Open with CodeSandbox Open in GitHub Codespaces

🧑‍🚀 Seasoned astronaut? Delete this file. Have fun!

🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── 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.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

Any static assets, like images, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

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

👀 Want to learn more?

Feel free to check our documentation or jump into our Discord server.