https://github.com/ohosvscode/docs

📄 Documentation for our projects.
https://github.com/ohosvscode/docs

Last synced: 6 months ago
JSON representation

📄 Documentation for our projects.

• Host: GitHub
• URL: https://github.com/ohosvscode/docs
• Owner: ohosvscode
• Created: 2025-07-22T19:48:49.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-24T18:59:19.000Z (6 months ago)
• Last Synced: 2026-01-25T07:51:04.030Z (6 months ago)
• Language: MDX
• Homepage: https://arkcode.dev
• Size: 5.78 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Arkcode docs

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

[![Netlify Status](https://api.netlify.com/api/v1/badges/f156b70a-1957-42fa-92d4-e66a3b5a916b/deploy-status)](https://app.netlify.com/projects/arkcode/deploys)

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/ohosvscode/docs/tree/main/examples/basics)

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/ohosvscode/docs/tree/main/examples/basics)

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/ohosvscode/docs)

## 🚀 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                     |