mirror of
https://github.com/Xahau/xahau-web.git
synced 2025-11-03 11:55:48 +00:00
575598f42e
* Add TOML and advanced-config webpages to infra section and minor edits to existing sections. * Update the Infra section of the index page for the docs. Begin adding content to the TOML page. * Fix header levels (promote L3 -> L2) in many infra docs. * Add webserver configuration and TOML file contents. * Document the '[ORGANIZATION]' section for the TOML. * Finish the identity page & minor updates/revisions on other pages for consistency. * Add clustering. * Document memory (rwdb) database. * Remove erronious file * Remove section header for 'Ledger Pinning'. * Spell Xahau correctly :) Co-authored-by: tequ <git@tequ.dev> * proofread Co-authored-by: tequ <git@tequ.dev> * proofread Co-authored-by: tequ <git@tequ.dev> --------- Co-authored-by: tequ <git@tequ.dev> Co-authored-by: Thomas Silkjær <thomas@inftf.org>
Xahau website and documentation
Project Structure
Inside the project, these are the most relevant folders for collaboration
/
├── public/
├── src/
│ └── assets/
│ └── ecosystem-logos/
│ └── content/
│ └── docs/
│ └── docs/
│ └── pages/
│ └── schemas/
The project is using .mdx files for content, which combines markdown with JSX. When editing content, look at the existing files for reference on how various elements are used, such as LinkButton, LinkCard, Aside etc.
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 |
Standards for Formatting Contributions
When contributing, please adhere to the standards defined in "contributing.md".