Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/innkeeping/hyperfy.how
Docs meets Awesome Hyperfy v2
https://github.com/innkeeping/hyperfy.how
List: hyperfy.how
astro awesome-list game-engine hyperfyv2 markdown starlight-astro threejs web3
Last synced: about 5 hours ago
JSON representation
Docs meets Awesome Hyperfy v2
- Host: GitHub
- URL: https://github.com/innkeeping/hyperfy.how
- Owner: Innkeeping
- Created: 2025-02-10T04:41:23.000Z (3 days ago)
- Default Branch: main
- Last Pushed: 2025-02-12T12:06:25.000Z (about 19 hours ago)
- Last Synced: 2025-02-12T12:35:29.952Z (about 18 hours ago)
- Topics: astro, awesome-list, game-engine, hyperfyv2, markdown, starlight-astro, threejs, web3
- Language: MDX
- Homepage: https://hyperfy.how/
- Size: 1.19 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
*You can click 'Edit Page' on the bottom of any page to go directly to it in repo*
Hyperfy.how is a living community resource for [Hyperfy v2.](https://github.com/hyperfy-xyz/hyperfy)
It will continue to evolve as Hyperfy v2 progresses. (with your help! 🚀)
Easily add resources in markdown to the appropriate .md or .mdx file. If needed, create a new file. (be sure to start with frontmatter format of all others)
Sidebar and page link will autogenerate on 'resources' section based on the frontmatter title of the file in the 'resources' folder.
'resources' sidebar will be in order based on the .md/.mdx file name.
On 'guides' and up to 'welcome' section, you will need to add to astro.config.mjs. Order is based on astro.config.mjs. Easiest is to copy from above and edit. You can have nested sidebars.
---
### Starlight on Astro
Site is built using [Starlight on Astro](https://starlight.astro.build/)
For tips on using asides, badges, embeds, etc -- check the docs or find in this repo and copy.
When using any import/components, file must be .mdx
---
### Expressive Code
[Expressive code](https://expressive-code.com/key-features/syntax-highlighting/) is built into Starlight for code blocks/steps.
---
[](https://starlight.astro.build)
```
pnpm create astro --template starlight
```
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the `public/` directory.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm dev` | Starts local dev server at `localhost:4321` |
| `pnpm build` | Build your production site to `./dist/` |
| `pnpm preview` | Preview your build locally, before deploying |
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm astro -- --help` | Get help using the Astro CLI |
## 👀 Want to learn more?
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
[Expressive Code is installed in Starlight already](https://expressive-code.com/installation/#starlight)