docs: rewritting wiki with vitepress

[harilvfs]

yeah it’s kinda a big one jump for wiki or docs, we can say anything.

basically i have rewritten the whole wiki with vitepress docs build site.

and guess what, it looks fine. you can always look at the preview here

i don't know how you will merge this or accept this or not. but i am sure this may help users to view docs and read without any problem. it may be an easy way.

it may also be the easy way to contribute to docs, as you have wiki on github wiki pages where i don't know that we barely can contribute there.

so kind of my little time for this work. hope you like it. thank you.

btw if you merge this then you will need the following things to make this work:

first install bun from bun official site

if bun doesn't appear in your terminal, you may need to source the bun in ~/.bashrc or ~/.zshrc

then

bun install

i am assuming that you are in dotfiles repo dir

then initialize

bun add -D vitepress

now you are ready to go

you can run

bun run docs:dev

for viewing real-time changes

bun run docs:build

for building

and

bun run docs:preview

for previewing the built docs

also if you merge this for deploy, i have put a ci, but you also need to go to settings > pages > and in build and deployment, make the source from github actions. btw this step you should do before merging.

you can check out the actions part after that. after merging, click on the ci deploy, then after building, you will get something like https://mylinuxforwork.github.io/dotfiles/ you can put this in readme for docs site link.

btw if you are merging this pr, then squash and merge should be effective so it will crush all the commits into one commit that will be clean enough.

thanks again

[mylinuxforwork]

Wow. This looks beautiful. Thank you so much. Will look into it and come back to you later.