dahliaos / documentation Goto Github PK

View Code? Open in Web Editor NEW

80.0 5.0 14.0 34.98 MB

Documentation for dahliaOS

Home Page: https://docs.dahliaos.io

License: Apache License 2.0

TypeScript 10.49% JavaScript 0.31% MDX 89.20%

documentation docs dahliaos markdown md mdx nextjs nextra react tsx

documentation's Introduction

Website • Discord • Releases • Donate • Documentation

Documentation

Documentation for the dahliaOS project.
Read the documentation on the link here!

Development

To develop and locally test the documentation website:

1. Install development tools:

Install bun
Code editor of your choice (we recommend VSCode)

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

License

This project is licensed under the Apache 2.0 license

documentation's People

Contributors

Stargazers

Watchers

Forkers

asubedy evolutionevotv osphea laniku carbonatedcaffeine nmcain quintenvandamme playfloor thewickedkarma w4tch-d0gz masonmouse mahadydev reg44u44 goodstudio

documentation's Issues

Firefox 87 Donate font not correct displayed

The donate font is not correct displayed in firefox. This isn't an issue in chrome/chromium.

firefox 87

brave 1.22.71

E: Package 'libvirt-bin' has no installation candidate

Ubuntu 20.04, i get this error "E: Package 'libvirt-bin' has no installation candidate" following the installation guide from here https://github.com/dahlia-os/documentation/blob/master/how%20to%20run%20dahila/How%20To%20Run%20DahilaOS%20EN.md#ubuntu

404-license

When going to contribute and pressing on the license link it will show a 404 - not found.

Supported Hardware links lead to 404

When you click on the open button it will lead to a 404 page.

open button

404 page

upgrade to 5.15.2

Donate text has bold text when upgrading to Font Awesome 5.

[FEATURE REQUEST] Enable Flexsearch

Is there an existing issue for this?

I have searched the existing issues

Is your feature request related to a problem? Please describe.

No response

Describe the solution you'd like

Thanks for using Nextra! I noticed that your website is using the default search, which isn't looking very nice at the moment. Nextra is going to use Flexsearch by default in 2.0 stable release, and in the meantime you can opt-in it by enabling on these two options:

https://github.com/vercel/swr-site/blob/main/next.config.js#L4
https://github.com/vercel/swr-site/blob/main/theme.config.js#L42

So the website will have https://swr.vercel.app like full-text search without any further configurations.

Let me know if you have any questions, happy to help!

Describe alternatives you've considered

No response

Additional context

No response

Code of Conduct

I agree to follow this project's Code of Conduct

Error when using make Command after configuring menu

After I use the make command I get this *** PANGOLIN_DESKTOP declares having git sub-modules, but does not use the 'git' method (uses 'https' instead). Stop. I cannot figure this out and looked everywhere, any help please?