https://github.com/rehlds/rehlds.github.io
A documentation site for the ReHLDS organization built with Docusaurus. This site features a clean and attractive landing page, comprehensive documentation for core projects, and a blog for community updates and best practices.
https://github.com/rehlds/rehlds.github.io
blog community documentation docusaurus landing-page markdown rehlds
Last synced: 5 months ago
JSON representation
A documentation site for the ReHLDS organization built with Docusaurus. This site features a clean and attractive landing page, comprehensive documentation for core projects, and a blog for community updates and best practices.
- Host: GitHub
- URL: https://github.com/rehlds/rehlds.github.io
- Owner: rehlds
- Created: 2024-10-22T12:57:16.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-07-14T15:15:34.000Z (6 months ago)
- Last Synced: 2025-07-14T17:16:26.577Z (6 months ago)
- Topics: blog, community, documentation, docusaurus, landing-page, markdown, rehlds
- Language: MDX
- Homepage: https://rehlds.github.io
- Size: 2.11 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚 ReHLDS Documentation
This repository contains the documentation for the ReHLDS project, built using [Docusaurus](https://docusaurus.io/).
## Prerequisites
- Node.js version 22 LTS
- NPM (comes with Node.js)
- Install `yarn` (or `pnpm`, `bun`, etc. or use `npm`)
## Getting Started
1. Clone the repository
2. `node -v` Should print `v22.17.1` or other `22.x`
3. `corepack enable yarn`
4. `yarn -v`
5. Install the dependencies
```bash
yarn install --frozen-lockfile
```
1. Start the local development server
```bash
yarn start
```
This will launch the documentation at `http://localhost:3000` with hot reloading enabled. Any changes made to the content will automatically refresh the browser.
## Available Scripts
- **docusaurus**: Runs the Docusaurus CLI.
- **start**: Starts the development server.
- **build**: Builds the static website for production.
- **swizzle**: Customizes the Docusaurus theme.
- **deploy**: Deploys the website (requires configuration).
- **clear**: Cleans up the cached data and files.
- **serve**: Serves the production build locally.
- **write-translations**: Prepares translation files.
- **write-heading-ids**: Generates heading IDs for markdown.
- **typecheck**: Runs TypeScript type checking.
## Building for Production
To create a production build of the documentation:
```npm
yarn run build
```
The output will be in the `build` directory, which can be served by any static site hosting service.
## Deployment
To deploy the documentation site, make sure to configure the deployment settings in `docusaurus.config.js` and run:
```npm
yarn run deploy
```
## Type Checking
To check for TypeScript errors, run:
```npm
yarn run typecheck
```
This will ensure that all TypeScript code adheres to type definitions.
## Browser Support
This project follows the [browserslist](https://github.com/browserslist/browserslist) specification to support modern browsers in production and the last few versions of major browsers in development.
## Contributing
Feel free to contribute to the documentation by submitting pull requests. Please follow the contribution guidelines and ensure that your changes pass all checks before submitting.