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 days 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 (16 days ago)
• Default Branch: master
• Last Pushed: 2024-10-27T18:58:23.000Z (11 days ago)
• Last Synced: 2024-10-27T23:14:42.682Z (10 days ago)
• Topics: blog, community, documentation, docusaurus, landing-page, markdown, rehlds
• Language: TypeScript
• Homepage: https://rehlds.github.io
• Size: 415 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• 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 18 or higher

- NPM (comes with Node.js)

## Getting Started

1. Clone the repository

2. Install the dependencies

```bash

    npm install

```

3. Start the local development server

```bash

    npm run 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

    npm 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

    npm run deploy

```

## Type Checking

To check for TypeScript errors, run:

```npm

    npm 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.