Skip to content

Commit 2791caa

Browse files
committed
Update docs to reflect 2.4 changes
1 parent 65ef6b3 commit 2791caa

11 files changed

Lines changed: 47 additions & 25 deletions
230 KB
Loading

docs/src/content/docs/docs/v2/areas.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
55
import {Monitor, Plus, TextT, Faders, Folder, Stack, SignOut, SignIn, Trash, Export, PlusCircle, Door, DotsThreeVertical} from "@phosphor-icons/react";
66
import logo from '/public/img/logo.svg';
77

8-
98
## Introduction
109

1110
![Area](area.png)

docs/src/content/docs/docs/v2/color_picker.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,31 @@
22
title: Color picker
33
---
44

5-
![Color picker](color_picker.png)
5+
Colors can be selected by using two methods: The color toolbar and the color picker overlay.
66

7-
* Open, save the dialog to access it in other documents
8-
* Reset the palette for the default material palette
9-
* Add, remove and edit the name of the palette
10-
* Add new colors by clicking on the plus button in the bottom
11-
* Edit the colors by long clicking on the color
7+
To update the color palette, read the [pack documentation](/docs/v2/pack).
128

13-
You can access the color picker on the view tool by clicking on the color button.
9+
## Color toolbar
10+
11+
![Color toolbar](color_toolbar.png)
12+
13+
If this is enabled in the settings, a color toolbar will be shown when a colorable tool is selected. This toolbar allows you to quickly select a color from a predefined set of colors. Click on the plus icon to select a custom color.
14+
15+
## Color picker overlay
16+
17+
![Color picker overlay](color_picker_overlay.png)
18+
19+
This overlay can be opened by clicking on a property tile that is colorable, for example inside the properties panel of the pen tool. Click on a color to select it. Click on the custom button to open the custom color picker.
20+
21+
If you want to delete a color from the palette, right click on it (or long press on touch devices) and select delete.
22+
23+
### Custom color picker
24+
25+
![Custom color picker](color_picker.png)
26+
27+
Here you can select any color you want. On the left you can see a color wheel. Under it you can select the brightness of the color.
28+
Note: if you choose a darker color on the bottom, the wheel selection gets less precise.
29+
30+
Under the brightness slider you can see a preview of the selected color. You can also enter a hex code to select a color. It is specified as `#RRGGBB`, where `RR` is the red value, `GG` is the green value, and `BB` is the blue value in hexadecimal notation.
31+
32+
On the right you can see the red, green and blue values that make up the color. These values can be changed by dragging the sliders or by entering a value between 0 and 255. Pin the color to add it to the color palette.
289 KB
Loading
277 KB
Loading
257 KB
Loading

docs/src/content/docs/docs/v2/intro.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ To start working on the app, you have two options:
4646
<Tabs syncKey="platform">
4747
<TabItem label="Desktop">
4848

49-
![Welcome screen](welcome_screen_desktop.png)
49+
![Welcome screen](@assets/img/main.png)
5050
The top of the screen holds the update banner, a link to this documentation, and the <Gear className="inline-icon"/> Settings button. Finally, to the right of the <Gear className="inline-icon"/> Settings button, you have a drop-down menu for controlling when the update banner will appear (always/never/on updates).
5151

5252
The Files section is the main area to the left. Here, you can do the following operations:
@@ -64,15 +64,16 @@ To start working on the app, you have two options:
6464

6565
When opening Butterfly on a mobile device, you will be presented with a screen like this:
6666
![Welcome screen first part](welcome_screen_mobile_1.png)
67-
The top of the screen holds the update banner. Below it, you can find a link to this documentation, the <Gear className="inline-icon"/> Settings button, and a drop-down menu for controlling when the update banner will appear (always/never/on updates).
67+
The top of the screen you will see the release name and a link to the release notes and documentation.
6868

69-
Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates.
69+
Below those, you can find the Quickstart section with the templates available in the current location. For a fresh install, this includes the Light and Dark templates. Below the templates, you will see your recent files.
7070

71-
Scrolling down, you will see the Files section:
71+
Clicking on the files tab at the bottom will bring you to the file list:
7272
\
7373
![Welcome screen second part](welcome_screen_mobile_2.png)
7474
Here, you can do the following operations:
7575
- Select the display type (<GridFour className="inline-icon"/> Grid or <List className="inline-icon"/> List)
76+
- Reloading the file list
7677
- Select the [source storage](../storage) of the files
7778
- Sort the display order of the files
7879
- Add a folder, file, template, or import files by clicking the <Plus className="inline-icon"/> plus sign

docs/src/content/docs/docs/v2/pack.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,29 @@
22
title: Pack
33
---
44

5-
:::caution[Upcoming changes]
6-
7-
In-document packs will be deprecated soon. In the meantime, it is recommended to save your packs globally to ensure a smooth transition to future releases.
8-
9-
See [this issue](https://github.com/LinwoodDev/Butterfly/issues/805) for details.
10-
11-
:::
12-
135
A pack is a collection of components that can be used in the stamp tool. You can create your own pack or import an existing one. For this click on the top left corner and click on "Packs".
146

7+
Packs are saved globally, so you can use them in any document. If you want to share the pack in a document, you can bundle it with the document.
8+
159
## Properties
1610

17-
Name | Description
18-
---: | :---
19-
Name | The name of the pack
20-
Author | The author of the pack
21-
Description | A description of the pack
11+
| Name | Description |
12+
| ----------: | :------------------------ |
13+
| Name | The name of the pack |
14+
| Author | The author of the pack |
15+
| Version | The version of the pack |
16+
| Description | A description of the pack |
2217

2318
### Components
2419

2520
Components are a way to save elements that you use often. You can create your own components or import an existing one using packs.
2621

2722
Use the components navigator page to paste components into your notes.
23+
24+
## Styles
25+
26+
Styles are used to customize the appearance of the text. The paragraph styles can be used to format a whole paragraph (like a heading), while the text styles can be used to format only a part of the text (like a bold word).
27+
28+
## Palettes
29+
30+
The color palettes can be used to quickly select colors for the colorable tools. You will see a color picker overlay (like mentioned in the [color picker documentation](/docs/v2/color_picker)) when you edit a color picker.
-16 KB
Binary file not shown.
166 KB
Loading

0 commit comments

Comments
 (0)