From 1c55c8533a7d9cc804beb3ad06f5c0c186da6305 Mon Sep 17 00:00:00 2001 From: radiorambo Date: Tue, 16 Dec 2025 13:06:44 +0530 Subject: [PATCH] improve docs --- README.md | 4 +++- docs/advanced/advanced.md | 2 +- docs/installation/mac.md | 6 +++--- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58f04f06..ef59da2d 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,6 @@ npm run docs:build # Preview production build npm run docs:preview -``` \ No newline at end of file +``` + +**Note**: New pages are automatically routed based on their folder structure (e.g., `docs/docs/index.md` maps to `/docs/index`). To add them to the sidebar, update the `sidebar` configuration in `.vitepress/config.js`. \ No newline at end of file diff --git a/docs/advanced/advanced.md b/docs/advanced/advanced.md index 6c4616ef..fa7182f6 100644 --- a/docs/advanced/advanced.md +++ b/docs/advanced/advanced.md @@ -45,7 +45,7 @@ You may import or export themes using the buttons at the bottom-left of the them The below video demonstrates using the theme editor to make changes to the Dark theme color pallet. -[](https://github.com/user-attachments/assets/05c0cb7f-578f-4465-9691-77d694111349) + ## Command Line Interface diff --git a/docs/installation/mac.md b/docs/installation/mac.md index 037b3ce5..5ffd8ed2 100644 --- a/docs/installation/mac.md +++ b/docs/installation/mac.md @@ -2,9 +2,9 @@ This walkthrough should get you up and running with Libation on your Mac. -## Supports macOS 13 (Ventura) and above +> [!WARNING] Supports macOS 13 (Ventura) and above -## Install Libation +### Install Libation - Download the file from the latest release and extract it. - Apple Silicon (M1, M2, ...): `Libation.x.x.x-macOS-chardonnay-`**arm64**`.dmg` @@ -39,4 +39,4 @@ Then use `./LibationCli` to execute a command. ## Get Libation Running on Mac -[Run Libation on MacOS](https://user-images.githubusercontent.com/37587114/219271379-a922e4e1-48a0-48e4-bd81-48aa1226a4f5.mp4) +