Skip to content

Commit 059555d

Browse files
Daniele-rolliDaniele-rolli
committed
🗂️ Add Install documentation
1 parent 13fe7b6 commit 059555d

27 files changed

Lines changed: 1866 additions & 145 deletions

‎.DS_Store‎

0 Bytes
Binary file not shown.

‎_posts/Beaver Notes/User/2024-06-17-Markdown-Syntax.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ A math block can be inserted by typing $$. Clicking on a math block opens the Ka
8080

8181
# Mermaid Block
8282

83-
A mermaid block can be inserted by typing ::mermaid. The mermaid block supports the Mermaid.js syntax, allowing you to add beautiful flowcharts, diagrams, and charts seamlessly to your notes, making data easier to read. To discover more about using Mermaid, check out the [Contributing to the Docs]({% post_url 2024-06-17-Mermaid-Block %})
83+
A mermaid block can be inserted by typing ::mermaid. The mermaid block supports the Mermaid.js syntax, allowing you to add beautiful flowcharts, diagrams, and charts seamlessly to your notes, making data easier to read. To discover more about using Mermaid, check out the [Mermaid Block page]({% post_url 2024-06-17-Mermaid-Block %}).
8484

8585
Callouts come in **yellow, red, blue, green, black, and purple**.
8686

‎_posts/Beaver Notes/User/2025-01-19-Install.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
layout: post
3+
title: Download and Install Beaver Notes
4+
details: This page lists all supported ways to download and install Beaver Notes.
5+
category: Beaver Notes
6+
position: 1
7+
---
8+
9+
This guide lists all supported ways to download and install Beaver Notes on Windows, macOS, Linux (including Flatpak, DEB, RPM and AUR)
10+
11+
>If you are using a package manager (e.g., Scoop, Flathub, Homebrew), it is recommended to disable auto-updates in **Settings > About** to avoid potential conflicts.
12+
13+
## Install on Windows
14+
15+
### Default Setup (64-bit)
16+
17+
1. Open your browser and go to [Download Beaver Notes](https://beavernotes.com/#/Download).
18+
2. Click **Download** and select **Setup (64-bit)** to download the installer.
19+
3. Open the downloaded file and follow the installation instructions.
20+
21+
### Portable Version (64-bit)
22+
23+
1. Open your browser and go to [Download Beaver Notes](https://beavernotes.com/#/Download).
24+
2. Click **Download** and select **Portable (64-bit)** to download the portable version.
25+
3. Open the `.exe` file to run the app directly from the folder. Your data will be stored in a `data` folder located in the same directory as the `.exe` file.
26+
27+
### Scoop (Package Manager)
28+
29+
1. Open a PowerShell terminal.
30+
2. Run the following command to add the extras repository:
31+
```bash
32+
scoop bucket add extras
33+
```
34+
3. Install Beaver Notes by running:
35+
```bash
36+
scoop install extras/beaver-notes
37+
```
38+
4. Beaver Notes will be updated automatically when you update Scoop.
39+
40+
## Install on macOS
41+
42+
### DMG (Default Setup)
43+
44+
1. Open your browser and go to [Download Beaver Notes](https://beavernotes.com/#/Download).
45+
2. Click **Download** to get the `.dmg` file.
46+
3. Open the installation file and drag the app icon into the Applications folder.
47+
48+
### Homebrew
49+
50+
1. Open a terminal window.
51+
2. Run the following command to install Beaver Notes:
52+
```bash
53+
brew install --cask beaver-notes
54+
```
55+
56+
## Install on Linux
57+
58+
The installation method may vary depending on the Linux distribution and package manager you use.
59+
60+
### Flatpak (Recommended)
61+
62+
#### From Software Store (GNOME Software, Discover, etc.)
63+
64+
1. Open your distro's software store (e.g., GNOME Software or Discover).
65+
2. Search for **Beaver Notes**.
66+
3. Click **Install** and enter your password if prompted.
67+
68+
#### From Terminal
69+
70+
1. Open a terminal window.
71+
2. Run the following command to install Beaver Notes:
72+
```bash
73+
flatpak install flathub com.beavernotes.beavernotes
74+
```
75+
76+
### DEB (For Debian and Ubuntu-based Distros)
77+
78+
1. Open your browser and go to [Download Beaver Notes](https://beavernotes.com/#/Download).
79+
2. Click **Download** and select **Deb x64** or **Deb ARM** (64-bit). If unsure, choose **x64**.
80+
3. Open the installation file and follow the prompts to install. You may be asked for your password.
81+
82+
### RPM (For Fedora and CentOS-based Distros)
83+
84+
1. Open your browser and go to [Download Beaver Notes](https://beavernotes.com/#/Download).
85+
2. Click **Download** and select **RPM x64** or **RPM ARM** (64-bit). If unsure, choose **x64**.
86+
3. Open the installation file and follow the prompts to install. You may be asked for your password.
87+
88+
### AUR (For Arch Linux)
89+
90+
#### **1. Using `yay` (Recommended AUR Helper)**
91+
92+
1. Open a terminal window.
93+
2. Run the following command to install Beaver Notes:
94+
```bash
95+
yay -S beaver-notes
96+
```
97+
This will download, compile, and install Beaver Notes automatically.
98+
99+
#### **2. Manually Compiling with `makepkg -si`**
100+
101+
If you prefer to install without an AUR helper:
102+
103+
1. Ensure you have `git` and `base-devel` installed:
104+
```bash
105+
sudo pacman -S --needed git base-devel
106+
```
107+
2. Clone the AUR repository for the standard version (compiling from source):
108+
```bash
109+
git clone https://aur.archlinux.org/beaver-notes.git
110+
cd beaver-notes
111+
```
112+
Or for the binary version (precompiled):
113+
```bash
114+
git clone https://aur.archlinux.org/beaver-notes-bin.git
115+
cd beaver-notes-bin
116+
```
117+
3. Build and install the package:
118+
```bash
119+
makepkg -si
120+
```
121+
122+
## AppImage (Portable)
123+
124+
1. Open your browser and go to [Download Beaver Notes](https://beavernotes.com/#/Download).
125+
2. Click **Download** and select **AppImage x64** or **AppImage ARM** (64-bit). If unsure, choose **x64**.
126+
3. Open the `.appimage` file to run the app directly, like any other portable application.
127+
128+
## 💖 Special Thanks
129+
130+
A heartfelt thank you to the dedicated contributors who help make Beaver Notes more accessible:
131+
132+
- [**o-l-a-v**](https://github.com/o-l-a-v) – Maintainer of our Scoop package.
133+
- The amazing teams behind [**Scoop.sh**](https://scoop.sh) and [**Homebrew**](https://brew.sh).
134+
- [**Moabeat**](https://github.com/moabeat-berlin) – Maintainer of the [AUR package](https://aur.archlinux.org/beaver-notes.git).
135+
- [**begin-theadventure**](https://github.com/begin-theadventure) – Maintainer of the [AUR binary package](https://aur.archlinux.org/beaver-notes-bin.git).
136+
137+
Beaver wouldn’t be possible without your contribution.

‎_site/_posts/Beaver Notes/User/2024-06-17-Importing-Markdown.html‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,15 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
253253
</h2>
254254
<ul>
255255

256+
<li class="mb-2">
257+
<a
258+
href="/beaver%20notes/2025/01/19/Install.html"
259+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2025/01/19/Install.html"
260+
>
261+
Download and Install Beaver Notes
262+
</a>
263+
</li>
264+
256265
<li class="mb-2">
257266
<a
258267
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
@@ -273,19 +282,19 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
273282

274283
<li class="mb-2">
275284
<a
276-
href="/beaver%20notes/2024/06/17/Sync.html"
277-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
285+
href="/beaver%20notes/2024/06/17/Labels.html"
286+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
278287
>
279-
Syncing Notes
288+
Using Labels
280289
</a>
281290
</li>
282291

283292
<li class="mb-2">
284293
<a
285-
href="/beaver%20notes/2024/06/17/Labels.html"
286-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
294+
href="/beaver%20notes/2024/06/17/Sync.html"
295+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
287296
>
288-
Using Labels
297+
Syncing Notes
289298
</a>
290299
</li>
291300

@@ -388,10 +397,10 @@ <h2 id="3-importing-the-archive">3. Importing the Archive</h2>
388397
>
389398

390399
<a
391-
href="/beaver%20notes/2024/06/17/Markdown-Syntax.html"
400+
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
392401
class="px-4 py-2 text-sm font-medium text-amber-400"
393402
>
394-
Next: Markdown Syntax &rarr;
403+
Next: Navigate the Interface &rarr;
395404
</a>
396405

397406
</nav>

‎_site/_posts/Beaver Notes/User/2024-06-17-Labels.html‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,15 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
253253
</h2>
254254
<ul>
255255

256+
<li class="mb-2">
257+
<a
258+
href="/beaver%20notes/2025/01/19/Install.html"
259+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2025/01/19/Install.html"
260+
>
261+
Download and Install Beaver Notes
262+
</a>
263+
</li>
264+
256265
<li class="mb-2">
257266
<a
258267
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
@@ -273,19 +282,19 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
273282

274283
<li class="mb-2">
275284
<a
276-
href="/beaver%20notes/2024/06/17/Sync.html"
277-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
285+
href="/beaver%20notes/2024/06/17/Labels.html"
286+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
278287
>
279-
Syncing Notes
288+
Using Labels
280289
</a>
281290
</li>
282291

283292
<li class="mb-2">
284293
<a
285-
href="/beaver%20notes/2024/06/17/Labels.html"
286-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
294+
href="/beaver%20notes/2024/06/17/Sync.html"
295+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
287296
>
288-
Using Labels
297+
Syncing Notes
289298
</a>
290299
</li>
291300

@@ -360,10 +369,10 @@ <h2 id="deleting-a-label">Deleting a label</h2>
360369
>
361370

362371
<a
363-
href="/beaver%20notes/2024/06/17/Markdown-Syntax.html"
372+
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
364373
class="px-4 py-2 text-sm font-medium text-amber-400"
365374
>
366-
Next: Markdown Syntax &rarr;
375+
Next: Navigate the Interface &rarr;
367376
</a>
368377

369378
</nav>

‎_site/_posts/Beaver Notes/User/2024-06-17-Lock-Noted.html‎

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,15 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
253253
</h2>
254254
<ul>
255255

256+
<li class="mb-2">
257+
<a
258+
href="/beaver%20notes/2025/01/19/Install.html"
259+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2025/01/19/Install.html"
260+
>
261+
Download and Install Beaver Notes
262+
</a>
263+
</li>
264+
256265
<li class="mb-2">
257266
<a
258267
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
@@ -273,19 +282,19 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
273282

274283
<li class="mb-2">
275284
<a
276-
href="/beaver%20notes/2024/06/17/Sync.html"
277-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
285+
href="/beaver%20notes/2024/06/17/Labels.html"
286+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
278287
>
279-
Syncing Notes
288+
Using Labels
280289
</a>
281290
</li>
282291

283292
<li class="mb-2">
284293
<a
285-
href="/beaver%20notes/2024/06/17/Labels.html"
286-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
294+
href="/beaver%20notes/2024/06/17/Sync.html"
295+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
287296
>
288-
Using Labels
297+
Syncing Notes
289298
</a>
290299
</li>
291300

@@ -365,10 +374,10 @@ <h2 id="use-a-password-to-lock-notes">Use a Password to Lock Notes</h2>
365374
>
366375

367376
<a
368-
href="/beaver%20notes/2024/06/17/Markdown-Syntax.html"
377+
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
369378
class="px-4 py-2 text-sm font-medium text-amber-400"
370379
>
371-
Next: Markdown Syntax &rarr;
380+
Next: Navigate the Interface &rarr;
372381
</a>
373382

374383
</nav>

‎_site/_posts/Beaver Notes/User/2024-06-17-Markdown-Syntax.html‎

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,15 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
253253
</h2>
254254
<ul>
255255

256+
<li class="mb-2">
257+
<a
258+
href="/beaver%20notes/2025/01/19/Install.html"
259+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2025/01/19/Install.html"
260+
>
261+
Download and Install Beaver Notes
262+
</a>
263+
</li>
264+
256265
<li class="mb-2">
257266
<a
258267
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
@@ -273,19 +282,19 @@ <h2 class="text-lg font-bold mb-4 dark:text-neutral-100">
273282

274283
<li class="mb-2">
275284
<a
276-
href="/beaver%20notes/2024/06/17/Sync.html"
277-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
285+
href="/beaver%20notes/2024/06/17/Labels.html"
286+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
278287
>
279-
Syncing Notes
288+
Using Labels
280289
</a>
281290
</li>
282291

283292
<li class="mb-2">
284293
<a
285-
href="/beaver%20notes/2024/06/17/Labels.html"
286-
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Labels.html"
294+
href="/beaver%20notes/2024/06/17/Sync.html"
295+
class="dark:hover:bg-neutral-700 hover:bg-neutral-100 dark:text-neutral-100 p-2 w-full rounded-lg /beaver%20notes/2024/06/17/Sync.html"
287296
>
288-
Using Labels
297+
Syncing Notes
289298
</a>
290299
</li>
291300

@@ -411,7 +420,7 @@ <h1 id="math-block">Math Block</h1>
411420

412421
<h1 id="mermaid-block">Mermaid Block</h1>
413422

414-
<p>A mermaid block can be inserted by typing ::mermaid. The mermaid block supports the Mermaid.js syntax, allowing you to add beautiful flowcharts, diagrams, and charts seamlessly to your notes, making data easier to read. To discover more about using Mermaid, check out the <a href="/beaver%20notes/2024/06/17/Mermaid-Block.html">Contributing to the Docs</a></p>
423+
<p>A mermaid block can be inserted by typing ::mermaid. The mermaid block supports the Mermaid.js syntax, allowing you to add beautiful flowcharts, diagrams, and charts seamlessly to your notes, making data easier to read. To discover more about using Mermaid, check out the <a href="/beaver%20notes/2024/06/17/Mermaid-Block.html">Mermaid Block page</a>.</p>
415424

416425
<p>Callouts come in <strong>yellow, red, blue, green, black, and purple</strong>.</p>
417426

@@ -434,10 +443,10 @@ <h1 id="labels">Labels</h1>
434443
>
435444

436445
<a
437-
href="/beaver%20notes/2024/06/17/Markdown-Syntax.html"
446+
href="/beaver%20notes/2024/06/17/Navigate-Interface.html"
438447
class="px-4 py-2 text-sm font-medium text-amber-400"
439448
>
440-
Next: Markdown Syntax &rarr;
449+
Next: Navigate the Interface &rarr;
441450
</a>
442451

443452
</nav>

0 commit comments

Comments
 (0)