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
8 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 4dd4be6e8a fix: Remove garbage "hash-source" path from content 
Previously, when this was used as a flake, the src/content/wiki directory
was as empty folder. This meant that the nix script would move the
content in, keeping the source folder name intact

By moving the content of the folder, we can mitigate this issue no matter
whether the folder was pre-existing
2024-05-17 16:35:28 -04:00
.vscode feat: Add project configuration 2024-05-17 00:03:19 +00:00
nix fix: Remove garbage "hash-source" path from content 2024-05-17 16:35:28 -04:00
public feat: Initial code commit 2024-05-17 00:07:33 +00:00
src feat: Add wiki content via submodule 2024-05-17 00:59:16 +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
flake.lock feat: Add nix package 2024-05-17 00:59:16 +00:00
flake.nix feat: Add nix package 2024-05-17 00:59:16 +00:00
package-lock.json feat: Add nix package 2024-05-17 00:59:16 +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.