https://github.com/dahliaos/documentation

Documentation for dahliaOS
https://github.com/dahliaos/documentation

dahliaos docs documentation hacktoberfest markdown md mdx nextjs nextra react tsx typescript

Last synced: 26 days ago
JSON representation

Documentation for dahliaOS

• Host: GitHub
• URL: https://github.com/dahliaos/documentation
• Owner: dahliaOS
• License: apache-2.0
• Created: 2019-04-26T07:18:31.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T13:44:27.000Z (9 months ago)
• Last Synced: 2024-04-22T12:33:17.714Z (7 months ago)
• Topics: dahliaos, docs, documentation, hacktoberfest, markdown, md, mdx, nextjs, nextra, react, tsx, typescript
• Language: MDX
• Homepage: https://docs.dahliaos.io
• Size: 34 MB
• Stars: 81
• Watchers: 5
• Forks: 14
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


Website •

Discord •

Releases •

Donate •

Documentation

# Documentation

![Website](https://img.shields.io/website?url=https%3A%2F%2Fdocs.dahliaos.io)

![GitHub](https://img.shields.io/github/license/dahliaos/documentation?color=brightgreen)

- **Documentation** for the dahliaOS project.

- **Read the documentation** on the link [here](https://docs.dahliaos.io)!

## Development

To develop and locally test the documentation website:

### 1. Install development tools:

1. [Install bun](https://bun.sh/)

1. Code editor of your choice (we recommend [VSCode](https://code.visualstudio.com/))

### 2. Install dependencies:

Install node modules required to run the blog by running:

```

bun install

```

### 3. Start the Next.js dev server:

```

bun dev

```

In a browser, load the page [localhost:3000](http://localhost:3000) and you should now be able to test the blog while making your changes.

Next.js' dev server has hot reloading so no need to restart the instance when it's running!

### 4. Build:

After making your changes and verifying it all works in the dev server, furtherly test them out by building the blog:

```

bun run build

```

### 5. Start:

```

bun start

```

In a browser, load the page [localhost:3000](http://localhost:3000) and you should now be able to view the built blog.

## Contribute

If you're wondering how to contribute to the project, please refer to [CONTRIBUTING.md](/CONTRIBUTING.md)

## Sponsored by



  



## License



  

  



Copyright @ 2019-2023 - The dahliaOS Authors - [email protected]

This project is licensed under the [Apache 2.0 license](/LICENSE)