Merge branch 'main' into develop

LinwoodDev · Nov 14, 2021 · 67b15a0 · 67b15a0 · vercel · Nov 14, 2021
2 parents d435604 + 1af2706
commit 67b15a0
Show file tree

Hide file tree

Showing 55 changed files with 930 additions and 0 deletions.
diff --git a/docs/static/img/undraw_docusaurus_mountain.svg b/docs/static/img/undraw_docusaurus_mountain.svg
diff --git a/docs/static/img/undraw_docusaurus_react.svg b/docs/static/img/undraw_docusaurus_react.svg
diff --git a/docs/static/img/undraw_docusaurus_tree.svg b/docs/static/img/undraw_docusaurus_tree.svg
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/background/_category_.json b/docs/versioned_docs/version-1.0.0-alpha.0/background/_category_.json
@@ -0,0 +1,3 @@
+{
+    "label":"Background"
+}
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/background/intro.md b/docs/versioned_docs/version-1.0.0-alpha.0/background/intro.md
@@ -0,0 +1,14 @@
+---
+sidebar_label: Introduction
+---
+
+# Background
+
+You can customize the background of the paper.
+Click on the background icon in the view tool to add it.
+
+## Configuration
+
+Width and height are the general settings of the box.
+Space and count are important if you want to add a complex structure.
+See [the music paper](./music) for more. Set this to 1 on x or/and y to let the lines rendered.
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/background/music.md b/docs/versioned_docs/version-1.0.0-alpha.0/background/music.md
@@ -0,0 +1,12 @@
+# Music paper
+
+| Property | Value |
+| -------: | :---- |
+|    Width | 200   |
+|   Height | 5     |
+|  Count X | 1     |
+|  Count Y | 5     |
+|  Space X | 10    |
+|  Space Y | 60    |
+
+See [the introduction](intro) for more information.
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/background/quad.md b/docs/versioned_docs/version-1.0.0-alpha.0/background/quad.md
@@ -0,0 +1,12 @@
+# Quad paper
+
+| Property | Value |
+| -------: | :---- |
+|    Width | 15    |
+|   Height | 15    |
+|  Count X | 1     |
+|  Count Y | 1     |
+|  Space X | 0     |
+|  Space Y | 0     |
+
+See [the introduction](intro) for more information.
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/background/ruled.md b/docs/versioned_docs/version-1.0.0-alpha.0/background/ruled.md
@@ -0,0 +1,12 @@
+# Ruled paper
+
+| Property | Value |
+| -------: | :---- |
+|    Width | 0     |
+|   Height | 25    |
+|  Count X | 0     |
+|  Count Y | 1     |
+|  Space X | 0     |
+|  Space Y | 0     |
+
+See [the introduction](intro) for more information.
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/home.png b/docs/versioned_docs/version-1.0.0-alpha.0/home.png
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/intro.md b/docs/versioned_docs/version-1.0.0-alpha.0/intro.md
@@ -0,0 +1,35 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+![Banner](/img/banner.png)
+
+---
+
+> Welcome to Butterfly, the opensource note app.
+> Use the sidebar to navigate through the wiki.
+
+## Getting started
+
+Visit [the downloads](/downloads) to download the app for your platform.
+Use [web version](https://butterfly.linwood.dev) if you cannot find your platform.
+
+![Home page](home.png)
+
+Then you can open the app. On the screen you can see all documents you can edit. On the first start it should be empty.
+To open a file, use the open button in the right corner. The settings button is also there.
+Create a document by clicking on the bottom right plus icon. Give the document a name.
+Click oo the document to open it.
+
+## Main view
+
+![Main view](main.png)
+
+With the top left button you can go back to the document list. The document name will be displayed on the right of it. Undo, redo and project settings are in the top right corner.
+
+Below it, you can find the toolbar. Left, you can switch between view and edit mode. Right to it, there you find the zoom options. In the top right corner there are the tool options.
+
+- The view toolbar options are background, export and save.
+- The edit toolbar options are the painters. You can find [here](background/intro) more.
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/main.png b/docs/versioned_docs/version-1.0.0-alpha.0/main.png
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/painters/_category_.json b/docs/versioned_docs/version-1.0.0-alpha.0/painters/_category_.json
@@ -0,0 +1,3 @@
+{
+    "label":"Painters"
+}
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/painters/eraser.md b/docs/versioned_docs/version-1.0.0-alpha.0/painters/eraser.md
@@ -0,0 +1,15 @@
+---
+sidebar_label: Eraser
+sidebar_position: 3
+---
+
+# Eraser painter
+
+With this painter you can erase the elements on the paper.
+
+## Configuration
+
+|          Property | Default | Description                                                                      |
+| ----------------: | :-----: | :------------------------------------------------------------------------------- |
+|      Stroke width |    5    | The width of the stroke                                                          |
+| Stroke multiplier |    1    | If you have a stylus, this is the multiplier which will be added to the pressure |
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/painters/intro.md b/docs/versioned_docs/version-1.0.0-alpha.0/painters/intro.md
@@ -0,0 +1,16 @@
+---
+sidebar_position: 1
+sidebar_label: Introduction
+---
+
+# Painters
+
+Painters can edit the paper.
+You can find it in the edit tool in the bottom right corner.
+
+Use the sidebar to learn more about the painters.
+
+Create a new painter by clicking on the plus icon. Change the painter order by dragging and change the painter by clicking.
+If you click on a selected tool you can configure the painter.
+
+The name of the painter will be displayed as tooltip on hover on the painter.
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/painters/label.md b/docs/versioned_docs/version-1.0.0-alpha.0/painters/label.md
@@ -0,0 +1,14 @@
+---
+sidebar_label: Label
+sidebar_position: 5
+---
+
+# Label painter
+
+With this painter you can add text to the paper.
+
+## Configuration
+
+| Property | Default | Description          |
+| -------: | :-----: | :------------------- |
+|     Size |   12    | The size of the text |
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/painters/path_eraser.md b/docs/versioned_docs/version-1.0.0-alpha.0/painters/path_eraser.md
@@ -0,0 +1,16 @@
+---
+sidebar_label: Path eraser
+sidebar_position: 4
+---
+
+# Path eraser painter
+
+With this painter you can delete the whole path on the paper.
+
+## Configuration
+
+|          Property | Default | Description                                                                                                     |
+| ----------------: | :-----: | :-------------------------------------------------------------------------------------------------------------- |
+|      Stroke width |    5    | The width of the stroke                                                                                         |
+| Stroke multiplier |    1    | If you have a stylus, this is the multiplier which will be added to the pressure                                |
+| Can delete eraser |  false  | This setting controls if you can remove the path of the eraser. The path under the removed eraser will be shown |
diff --git a/docs/versioned_docs/version-1.0.0-alpha.0/painters/pen.md b/docs/versioned_docs/version-1.0.0-alpha.0/painters/pen.md
@@ -0,0 +1,16 @@
+---
+sidebar_label: Pen
+sidebar_position: 2
+---
+
+# Pen painter
+
+With this painter you can draw on this paper.
+
+## Configuration
+
+|          Property | Default | Description                                                                      |
+| ----------------: | :-----: | :------------------------------------------------------------------------------- |
+|             Color |  Black  | The color that will be drawn                                                     |
+|      Stroke width |    5    | The width of the stroke                                                          |
+| Stroke multiplier |    1    | If you have a stylus, this is the multiplier which will be added to the pressure |
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/background/_category_.json b/docs/versioned_docs/version-1.0.0-beta.0/background/_category_.json
@@ -0,0 +1,3 @@
+{
+    "label":"Background"
+}
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/background/intro.md b/docs/versioned_docs/version-1.0.0-beta.0/background/intro.md
@@ -0,0 +1,16 @@
+---
+sidebar_label: Introduction
+---
+
+# Background
+
+You can customize the background of the paper.
+Click on the background icon in the view tool to add it.
+
+## Configuration
+
+Width and height are the general settings of the box.
+Space and count are important if you want to add a complex structure.
+See [the music paper](./music) for more. Set this to 1 on x or/and y to let the lines rendered.
+
+Additionally you can customize the color of the background.
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/background/music.md b/docs/versioned_docs/version-1.0.0-beta.0/background/music.md
@@ -0,0 +1,12 @@
+# Music paper
+
+| Property | Value |
+| -------: | :---- |
+|    Width | 200   |
+|   Height | 5     |
+|  Count X | 1     |
+|  Count Y | 5     |
+|  Space X | 10    |
+|  Space Y | 60    |
+
+See [the introduction](intro) for more information.
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/background/quad.md b/docs/versioned_docs/version-1.0.0-beta.0/background/quad.md
@@ -0,0 +1,12 @@
+# Quad paper
+
+| Property | Value |
+| -------: | :---- |
+|    Width | 15    |
+|   Height | 15    |
+|  Count X | 1     |
+|  Count Y | 1     |
+|  Space X | 0     |
+|  Space Y | 0     |
+
+See [the introduction](intro) for more information.
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/background/ruled.md b/docs/versioned_docs/version-1.0.0-beta.0/background/ruled.md
@@ -0,0 +1,12 @@
+# Ruled paper
+
+| Property | Value |
+| -------: | :---- |
+|    Width | 0     |
+|   Height | 25    |
+|  Count X | 0     |
+|  Count Y | 1     |
+|  Space X | 0     |
+|  Space Y | 0     |
+
+See [the introduction](intro) for more information.
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/color_picker.md b/docs/versioned_docs/version-1.0.0-beta.0/color_picker.md
@@ -0,0 +1,13 @@
+---
+title: Color picker
+---
+
+![Color picker](color_picker.png)
+
+* Open, save the dialog to access it in other documents
+* Reset the palette for the default material palette
+* Add, remove and edit the name of the palette
+* Add new colors by clicking on the plus button in the bottom
+* Edit the colors by long clicking on the color
+
+You can access the color picker on the view tool by clicking on the color button.
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/color_picker.png b/docs/versioned_docs/version-1.0.0-beta.0/color_picker.png
diff --git a/docs/versioned_docs/version-1.0.0-beta.0/home.png b/docs/versioned_docs/version-1.0.0-beta.0/home.png