Skip to content

Commit

Permalink
Update docs: features & install
Browse files Browse the repository at this point in the history
  • Loading branch information
EinMelih committed Jan 2, 2025
1 parent 3078922 commit 95b9a91
Show file tree
Hide file tree
Showing 9 changed files with 77 additions and 41 deletions.
4 changes: 2 additions & 2 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down
Binary file added docs/src/assets/clippy-showcase.webp
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/src/content/docs/features/clipboard-history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Clipboard-History
description: A quick guide to install Clippy.
---
4 changes: 4 additions & 0 deletions docs/src/content/docs/features/cloud-sync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Cloud-Sync
description: A quick guide to install Clippy.
---
4 changes: 4 additions & 0 deletions docs/src/content/docs/features/file-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: File-Support
description: A quick guide to install Clippy.
---
7 changes: 7 additions & 0 deletions docs/src/content/docs/features/hotkeys.md
Original file line number Diff line number Diff line change
@@ -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)
38 changes: 0 additions & 38 deletions docs/src/content/docs/guides/example.md

This file was deleted.

55 changes: 55 additions & 0 deletions docs/src/content/docs/guides/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Quick Start
description: A quick guide to install Clippy.
---

<p align="center">
<br />
Clipboard Manager made with Tauri, Solid & Sea-Orm
<br />
<a href="https://github.com/0-don/clippy/releases/latest">Try it out</a>
·
<a href="https://github.com/0-don/clippy/issues">Report Bug</a>
·
<a href="https://github.com/0-don/clippy/issues">Request Feature</a>
<br />
</p>

<p align="center">
<b>Successor of <a href="https://github.com/0-don/clippy-ts">the Electron Clippy</a></b>
</p>

---

# 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
```
2 changes: 1 addition & 1 deletion docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hero:
file: ../../assets/Clippy.webp
actions:
- text: Quick Start
link: /guides/example/
link: /guides/installation/
icon: right-arrow
---

Expand Down

0 comments on commit 95b9a91

Please sign in to comment.