diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 44734845..a4485482 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -21,11 +21,11 @@ export default defineConfig({ label: "Quick Start", items: [ // Each item here is one entry in the navigation menu. - { label: "Installation Guide", slug: "guides/example" }, + { label: "Installation Guide", slug: "guides/installation" }, { label: "Features", items: [ - { label: "Clipboard History", slug: "features/clipboard-history" }, + { label: "Clipboard History", slug: "features/clipboard-history " }, { label: "Global Hotkeys", slug: "features/hotkeys" }, { label: "Cloud Sync", slug: "features/cloud-sync" }, { label: "File Support", slug: "features/file-support" }, diff --git a/docs/src/assets/clippy-showcase.webp b/docs/src/assets/clippy-showcase.webp new file mode 100644 index 00000000..6023238c Binary files /dev/null and b/docs/src/assets/clippy-showcase.webp differ diff --git a/docs/src/content/docs/features/clipboard-history.md b/docs/src/content/docs/features/clipboard-history.md new file mode 100644 index 00000000..11be0499 --- /dev/null +++ b/docs/src/content/docs/features/clipboard-history.md @@ -0,0 +1,4 @@ +--- +title: Clipboard-History +description: A quick guide to install Clippy. +--- diff --git a/docs/src/content/docs/features/cloud-sync.md b/docs/src/content/docs/features/cloud-sync.md new file mode 100644 index 00000000..e3ee50e6 --- /dev/null +++ b/docs/src/content/docs/features/cloud-sync.md @@ -0,0 +1,4 @@ +--- +title: Cloud-Sync +description: A quick guide to install Clippy. +--- diff --git a/docs/src/content/docs/features/file-support.md b/docs/src/content/docs/features/file-support.md new file mode 100644 index 00000000..492f2bd6 --- /dev/null +++ b/docs/src/content/docs/features/file-support.md @@ -0,0 +1,4 @@ +--- +title: File-Support +description: A quick guide to install Clippy. +--- diff --git a/docs/src/content/docs/features/hotkeys.md b/docs/src/content/docs/features/hotkeys.md new file mode 100644 index 00000000..6e5cee50 --- /dev/null +++ b/docs/src/content/docs/features/hotkeys.md @@ -0,0 +1,7 @@ +--- +title: Hotkeys +description: A quick guide to install Clippy. +--- + +- Display/hide **ctrl+y** or **ctrl+d** (change in settings) +- Type out clipboard **ctrl+b** (where pasting isn't allowed) diff --git a/docs/src/content/docs/guides/example.md b/docs/src/content/docs/guides/example.md deleted file mode 100644 index 3a236cb9..00000000 --- a/docs/src/content/docs/guides/example.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Quick Start -description: A quick guide to install Clippy. ---- - -# Installation Guide - -Welcome to your **Installation Guide**! This is where you'll find the essential steps to set up and configure your project successfully. - ---- - -## Prerequisites - -- **Node.js** (version X.Y or higher) -- **Yarn** (or npm, depending on your preference) -- **Optional**: [Tool/Dependency] if your project requires it - -> **Note**: Replace these prerequisites with your project’s actual requirements. - ---- - -## Overview - -- [Download / Clone](#download--clone) -- [Install](#install) -- [Initial Configuration](#initial-configuration) -- [Troubleshooting](#troubleshooting) - ---- - -## Download / Clone - -You can download the project from [GitHub InsertLink] or clone it via: - -```bash -git clone - -``` diff --git a/docs/src/content/docs/guides/installation.md b/docs/src/content/docs/guides/installation.md new file mode 100644 index 00000000..bfda80b3 --- /dev/null +++ b/docs/src/content/docs/guides/installation.md @@ -0,0 +1,55 @@ +--- +title: Quick Start +description: A quick guide to install Clippy. +--- + +

+
+ Clipboard Manager made with Tauri, Solid & Sea-Orm +
+ Try it out + · + Report Bug + · + Request Feature +
+

+ +

+ Successor of the Electron Clippy +

+ +--- + +# Installation Guide + +Welcome to your **Installation Guide**! This is where you'll find the essential steps to set up and configure Clippy successfully. + +## Prerequisites + +Before you begin, ensure you have the following installed: + +- [Rust](https://www.rust-lang.org/tools/install) +- [Node.js](https://nodejs.org/en/download/) +- [Tauri](https://tauri.app/v1/guides/getting-started/prerequisites/) + +> **Note:** Replace these prerequisites with your project's specific requirements if necessary. + +--- + +## Installation Overview + +- [Download / Clone](#download--clone) +- [Install Dependencies](#install-dependencies) +- [Run the Application](#run-the-application) +- [Tested Platforms](#tested-platforms) + +--- + +## Download / Clone + +You can download the project from [GitHub](https://github.com/0-don/clippy) or clone it via: + +```bash +git clone https://github.com/0-don/clippy.git +``` diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index d42d45ce..f20e4da7 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -8,7 +8,7 @@ hero: file: ../../assets/Clippy.webp actions: - text: Quick Start - link: /guides/example/ + link: /guides/installation/ icon: right-arrow ---