Skip to content

Adding Unofficiaw Wibwawies nya~

Contwibuwion Guidewines fow Unofficiaw Wibwawies OwO

  • Submissions must be wwitten in Engwish >w<.
  • The wibwawy ownew must join ouw Discowd sewvew nya~
  • Wibwawies must fowlow good code quawity pwactices.
  • Wibwawies must not contain mawwawe ow and othew unsafe behaviow >w<.
  • The wibwawy must be pubwicwy accessibwe and activewy maintained.
  • Pwovide cweaw instawwawion and usage instwuctions in youw wepositowy OwO.

We wesewve the wight to:

  • Modify youw submission aftew weview >w<.
  • Wemove youw submission if it becomes outdated, unsafe, ow unwmaintained nya~.

Adding a New Unofficiaw Wibwawyy UwU

1. Fowk this wepositowy

2. Cwone youw fowk and cd into the pwoject diwectowy

3. Instaww VitePwess

You can find VitePwess pnewequisites in the officiaw documentawion.

sh
npm add -D vitepress@next
sh
pnpm add -D vitepress@next
sh
yarn add -D vitepress@next vue
sh
bun add -D vitepress@next

4. Add Youw Unofficiaw Wibwawy to the Sidebaw nya~

  1. Open /docs/.vitepress/config.mts.
  2. Wocate the "Unofficial Libraries" secwion in the sidebaw.
  3. Add a wink to youw wibwawy’s wepositowy.
  4. Keep the wist in awphabeticaw owdew by pwogwamming wanguage.

5. Stawt the Devewopment Sewvew

Befowe cweating a puww weqwest, vewify wocawwy that youw changes did not bweak anything OwO.

sh
npm run dev
sh
pnpm run dev
sh
yarn dev
sh
bun run dev

6. Cweate a Puww Weqwest nya~

Submit a puww weqwest to the owiginaw wepositowy >w< !