Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/himarplupi/docs-himarpl
HIMARPL Documentation Website serves as a guide for HIMARPL open source project contributions and as a reference for future Communication and Information Department staffs
https://github.com/himarplupi/docs-himarpl
astro mdx starlight-astro typescript
Last synced: about 1 month ago
JSON representation
HIMARPL Documentation Website serves as a guide for HIMARPL open source project contributions and as a reference for future Communication and Information Department staffs
- Host: GitHub
- URL: https://github.com/himarplupi/docs-himarpl
- Owner: himarplupi
- License: mit
- Created: 2024-07-27T01:23:35.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-08T14:04:10.000Z (2 months ago)
- Last Synced: 2024-12-08T15:18:01.789Z (2 months ago)
- Topics: astro, mdx, starlight-astro, typescript
- Language: MDX
- Homepage: https://docs.himarpl.com
- Size: 6.34 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# HIMARPL Technical Documentation
[](https://starlight.astro.build)
The official technical documentation for all HIMARPL (Software Engineering Student Association) open-source projects at the Education University of Indonesia.
## 🚀 Project Structure
Inside of this documentation project, you'll see the following folders and files:
```
.
├── public/
├── src/
│ ├── assets/
│ │ ├── docs/
│ │ └── config.ts
│ ├── styles/
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```
Documentation is written in `.md` or `.mdx` files in the `src/content/docs/` directory for English and `src/content/docs/id/` for Indonesian. 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 |
| :------------------ | :----------------------------------------------- |
| `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` |
## 📚 Documentation Structure
The documentation covers:
- Getting Started guides
- Project overviews and setup instructions
- Technical architecture and infrastructure
- Contribution guidelines
- Staff guides for Kominfo department
## 🌐 Deployment
This documentation is deployed on Vercel and available at [docs.himarpl.com](https://docs.himarpl.com)
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 👥 Contributing
Please read our [Contribution Guide](/CONTRIBUTING.md) before submitting any contributions.
## 🤝 Support
For questions or issues:
- Open a GitHub issue
- Contact Kominfo Department
- Visit [himarpl.com](https://www.himarpl.com)
## 👀 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).