13 |
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Files",
3 | "position": 3,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Files"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/about-files.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # About files
6 |
7 | 
8 |
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/context-menu.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 11
3 | ---
4 | # Context menu based on the type of file
5 |
6 | 
7 |
8 | 
9 |
10 | >🧠 It can be invoked through a **left-click**, and the choice of the **Get Info option on the file [File Context Menu (Left-click)](https://www.notion.so/File-Context-Menu-Left-click-84e162b3a94d4d66b9b2ea65fef2ea84).**
11 |
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/different-views.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 9
3 | ---
4 | # Different Views
5 |
6 | In Explorer windows, files and folders appear sorted or grouped by different attributes, such as name or type, in the different views, such as :
7 |
8 | 
9 |
10 | This is the one present in Windows 11
11 |
12 | - **Icons (Extra large, Large, Medium, or Small),**
13 | - **List,**
14 | - **Details,**
15 | - **Tiles,**
16 | - **Content.**
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/file-color-tagging.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 4
3 | ---
4 |
5 | # File Color Tagging
6 |
7 | ### The 5 colors will be :
8 |
9 | - Sea **Green**
10 | - Peach **Orange**
11 | - Vivid **Pink**
12 | - Magic **Purple**
13 | - Pineapple **Yellow**
14 |
15 | 
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/file-context-menu.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 12
3 | ---
4 | # File Context Menu
5 |
6 | 
7 |
8 | Thus, we have multiple features to implement, when it comes to the pie file context menu.
9 |
10 | ### That is:
11 |
12 | - **Get information** on the file ([Context menu based on the type of file](https://www.notion.so/Context-menu-based-on-the-type-of-file-622656d865b14f828466d36949417a68))
13 | - **Share** it with others
14 | - **Rename** the file
15 | - **Delete** the file (moving it into the [Garbage Bin](https://www.notion.so/Garbage-Bin-d8cde2592b6041b3ad0aa214840a642f))
16 | - **Duplicate** it (i.e. copy and paste it into the same place, while giving it a slightly different name)
17 | - **Copy** the File
18 | - **Pin it** to the Folder or Place it’s currently in
19 | - [**File Color Tagging** (see bottom left)](https://www.notion.so/File-Color-Tagging-see-bottom-left-f5c98edaf1b64775897dda0d176d5775)
20 | - **Open in a new Tab**
21 | - Just **Open the File** (new window)
22 |
23 |
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/file-sharing.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 5
3 | ---
4 |
5 | # File sharing
6 | Integrated into the browser and the Office Suite of products
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/icons-for-each-file-type.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 |
5 | # Icons for each file type
6 | This is a design thing mostly, so this page is for them.
7 |
8 | >🧠 If the file is empty, then we will show the empty folder icon, but if it isn’t empty, then we will show the filled file icon.
9 |
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/path-on-top.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 7
3 | ---
4 | # Path on top
5 | copying it and going back
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/searching-capabilities.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 8
3 | ---
4 | # Searching capabilities
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/sorting-capabilities.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Sorting capabilities
6 |
7 | We will give the user the ability to sort their file in *ascending and descending order* :
8 |
9 | - By **size**
10 | - By file **type** (.mp3, .docx, .ppt …)
11 | - By **date of creation**
12 | - **Last time opened** / changed
13 |
14 | 
15 |
16 |
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/Files/undo-redo-an-action.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 10
3 | ---
4 | # Undo / Redo an Action
--------------------------------------------------------------------------------
/docs/apps/MinimalApps/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Minimal Apps",
3 | "position": 2,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Minimal Apps"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/apps/apps-intro.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 |
5 | # Apps
6 | This section contains all the apps of Avdan AvdanOS
--------------------------------------------------------------------------------
/docs/avdanos/contributing/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Contributing to AvdanOS Project",
3 | "position": 2,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Contributing to AvdanOS Project"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/avdanos/contributing/design/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Design",
3 | "position": 3,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Design"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/avdanos/contributing/design/design_guidelines/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Design Guidelines",
3 | "position": 2,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Design Guidelines"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/avdanos/contributing/design/design_guidelines/intro.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | title: Introduction
4 | description: AvdanOS Design Guidelines Documentation
5 | ---
6 | # Introduction
7 |
8 | | Do ✅ | 37 |Don't ❌ | 38 |
|---|---|
|
43 | Navda is the display server of the AvdanOS project, implemented in Wayland. 44 |Wayland is an alternative to the older X Server standard which lets... 45 | |
46 |
47 | Navda is the display server of the AvdanOS project, implemented in Wayland. Wayland is a protocol alternative to the older X Server standard which lets... 48 | |
49 |
| Do ✅ | 65 |Don't ❌ | 66 |
|---|---|
|
71 | Navda is the display server of the AvdanOS project, implemented in Wayland. 72 |The Wayland protocol is an alternative to the older X Server standard which lets... 73 | |
74 |
75 | Navda is the display server of the AvdanOS project, implemented in Wayland. 76 |Wayland is a protocol alternative to the older X Server standard which lets. 77 | |
78 |
| Do ✅ | 90 |Don't ❌ | 91 |
|---|---|
|
96 | Navda is the display server of the AvdanOS project, implemented in Wayland. 97 |The Wayland protocol is an alternative to the older X Server standard which lets... 98 | |
99 |
100 | Navda is the display server of the AvdanOS project, implemented in Wayland. 101 |Wayland is a protocol alternative to the older X Server standard which lets. 102 | |
103 |
Bread??
8 | In the AvdanOS Community Discord Server bread is a big, big meme, we currently have a thread dedicated to bread! 🍞👍 9 |Tech Stack
13 | First, for the Wayland Compositor, which will allow us to add a lot of awesome features, we will use Rust and more specifically the Smithay lib. Meanwhile for the UI toolkit we'll use Rust with an easy and extensible UI library named egui 14 | 15 | Second of all, we might use other languages, such as C++ with their respective GUI libraries (for C++ it's Qt or Raylib... there are a lot of other options). 16 | 17 | 18 | 19 | 20 | 21 | And, finally, we all need to keep in mind, that there is no "one-fits-all solution": every action needs a tool to perform it. And those tools can be different. So wait for more news regarding the tech stack. We will surely inform you of any updates on our Discord server. 22 |Rust Resources
25 | Here are some amazing sites to get started on rust! 26 | 27 | Rust Book: https://doc.rust-lang.org/book/ 28 | 29 | Some rust Youtube videos: 30 | - https://youtu.be/br3GIIQeefY 31 | - https://youtu.be/iU21KZ4i6bU 32 | - https://youtu.be/5C_HPTJg5ek 33 | - https://youtu.be/ygL_xcavzQ4 34 | 35 | Some rust Youtube playlists: 36 | - https://youtube.com/playlist?list=PLai5B987bZ9CoVR-QEIN9foz4QCJ0H2Y8 37 | 38 |
12 | 
13 |
--------------------------------------------------------------------------------
/docs/avdanos/gui/cursor.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Cursor
3 | ---
4 |
5 | The cursor needs to be sleek and reliably adapted to the OS.
6 |
7 | 
8 |
9 | There are two different styles of cursors; black with a white contour and white with a black contour. Additionally, when choosing or selecting an object, it will turn into a pointing hand, allowing the user to have a little more accuracy while using the cursor.
10 |
11 | Like any other OS, when the cursor chooses text or just glides over it, the cursor will turn into a text caret.
12 |
13 | 
14 |
--------------------------------------------------------------------------------
/docs/avdanos/gui/dock.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Dock (aka Taskbar)
3 | ---
4 |
5 | :::danger
6 | TODO: @TechStudent11
7 | :::
8 |
9 | The Dock will be **rectangular with slightly rounded edges**. In addition to just the app icons, there will also be a **customizable widget** (it can be weather, mail, calendar, or your calls). There will be a **main area** (with the search and main menu) and a control area (battery, Wi-Fi connection, audio, Bluetooth, etc.)
10 |
11 |
12 | 
13 | 
14 | 
15 |
16 | ## App Area
17 |
18 | The App Area is pretty much what you would expect; it's just **apps being aligned in a Dock area**. You can re-arrange and change them however you want with the possibility to have them connected with separators or completely disconnected from one another.
19 |
20 | ## Main Area
21 |
22 | This is the bar in the middle of the second photo, which is similar to the leftmost part of a Windows 10 (or 11 if you have your taskbar aligned to the left) Taskbar. The content of the bar is not limited to:
23 | - The Main Menu Button (which would act like the Windows Start Menu)
24 | - A Search Button (for searching for files)
25 | - A Virtual Desktop Button (for switching Virtual Desktops)
26 | - Summon Dynamic Widgets [Go to docs](/docs/gui/widgets)
27 |
28 | ## App Widgets Area
29 |
30 | :::danger
31 | TODO: @TechStudent11
32 | :::
33 |
34 | ## Extended Info Section (Control Area)
35 |
36 | :::danger
37 | TODO: @TechStudent11
38 | :::
39 |
--------------------------------------------------------------------------------
/docs/avdanos/gui/widgets.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | title: Widgets
3 | ---
4 |
5 | Our widgets are similar to what you see on newer versions of macOS. They allow you to see quick information on your calendar, your mail, work, etc.
6 |
7 |
8 | ### 3 types of widgets:
9 | - The **desktop widgets** (first) are **always present**. They are pinned to the **desktop** and are added by the user in the Settings application.
10 | - The **taskbar widgets** (second) are present on the taskbar widget menu and can be opened by left-clicking them.
11 | - The **summoned widgets** (third) are present when you click on the widget button on the Dock (kind of like hidden widgets that are summoned to the screen).
12 |
13 | > 🧠 We need to figure out how to cohesively mash them together so that they wouldn't interfere with each other (**coordinate them somehow**).
14 |
15 | ## Desktop Widgets
16 |
17 | 
18 |
19 | ## Dock/Taskbar Widgets
20 |
21 | 
22 | 
23 | 
24 | 
25 |
26 | ## Summoned Widgets
27 |
28 | 
29 | 
30 |
--------------------------------------------------------------------------------
/docs/avdanos/intro.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 | # AvdanOS Overview
5 |
6 | Hello and welcome to the AvdanOS Docs!
7 |
8 | ## What is AvdanOS?
9 | ## The Concept
10 | AvdanOS is a design concept released by design YouTuber [Avdan](https://www.youtube.com/c/Avdan).
11 |
12 | This project is an attempt to implement the features showcased in the video *Introducing AvdanOS (Concept)*:
13 |
14 | import YTEmbed from "@site/src/components/media/youtube-embed";
15 |
16 |
13 |
--------------------------------------------------------------------------------
/docs/demo/demo-backrooms/libdrag.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # Drag&Drop library
5 |
6 | That's the lowest library, that controls drag&drop events.
7 |
8 | It manipulates directly the objects through CSS `transform`, so all transform changes can be applied only to the other elements except dragged one (may change with library upgrades).
9 |
10 | All dragged objects are stored in `dragList` _(private array variable)_ as __Objects__ (info). More info about it is [here](../libdrag/about)
11 |
12 | `CurrentTarget` is an object, that can be impacted, and `target` is the object that's being moved.
13 |
14 | Example: topbar - `currentTarget`, window - `target`
15 |
16 | Explaining simpler: `add -> listen -> drop`
17 |
18 | Library classes:
14 | 15 | - [Player](../libdemo/Player/about.mdx) 16 | - [Placeholder](../libdemo/Placeholder/about.mdx) 17 | 18 |
19 |
30 |
31 | All the examples are only examples, you can use this library in the way you want, limited only by your creativity and skills.
--------------------------------------------------------------------------------
/docs/demo/demo-backrooms/libwin.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # Window library
5 |
6 | This library is used to create windows, store functions and generate dock elements.
7 |
8 | Library functions:
20 | 21 | - [add](../libdrag/add) 22 | - [listen](../libdrag/listen) 23 | - [drop](../libdrag/drop) 24 | - [dropAll](../libdrag/dropAll) 25 | - [click](../libdrag/click) 26 | - [get](../libdrag/get) 27 | - [wipe](../libdrag/wipe) 28 | 29 |
9 |
16 |
17 | Global variables:
10 | 11 | - __demo_body__ 12 | - global `Object` that defines the demo body element 13 | - is used to set an embedded demo on a page 14 | 15 |
18 |
28 |
--------------------------------------------------------------------------------
/docs/demo/demo-backrooms/loadAdd.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # Add new static HTML, CSS styles, or script
5 |
6 | All load settings are stored in `index.html`, so to disable something or add, you just have to set it in the `` tag.
--------------------------------------------------------------------------------
/docs/demo/demo-backrooms/usage.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # Usage
5 |
6 | Library classes:
19 | 20 | - [Window](../libwin/Window/about.mdx) 21 | - [Appbar](../libwin/Appbar/about.mdx) 22 | - [Scrollbar](../libwin/Scrollbar/about.mdx) 23 | - [Workspace](../libwin/Workspace/add.mdx) 24 | - [Layer](../libwin/Layer/about.mdx) 25 | - [Keylogger](../libwin/Keylogger/about.mdx) 26 | 27 |
7 |
24 |
25 | Tabs:
8 | 9 | - Double click to close 10 | - Click to change to the tab 11 | - Hold Ctrl and click to tile 12 | - Drag to swap places (content also swaps) 13 | - Drag out to recreate the window 14 | - Drag out and drop in another window to add it there and tile 15 | - Drag out and drop in another window's topbar to add without tilling 16 | 17 | The first tab is unmovable, can't be closed with a double click and can't be swapped with other tabs (it's the window base tab). 18 | 19 | Tab position shows the content position, so to swap or add tilling just swap tabs. Fast and simple. 20 | 21 | `New tab` can't be moved, can't be dragged out, but can be double-clicked. After choosing an app it becomes a simple dynamic `win-tab`. 22 | 23 |
26 |
34 |
35 | Dock:
27 | 28 | - Drag and swap dock element's place 29 | - Drop in new space to set a new position 30 | - Drop in another dock element to merge 31 | - Drag out to the left or to the right to unmerge 32 | 33 |
36 |
43 |
44 | Appbar:
37 | 38 | - Drag and swap icon's place 39 | - Set the icon's position on the right side to be able to hide it 40 | - Click underline to minimalize/show back window 41 | 42 |
45 |
50 |
51 | Scrollbar:
46 | 47 | - hold Shift and scroll to swap the widget 48 | 49 |
52 |
--------------------------------------------------------------------------------
/docs/demo/demo-intro.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 | # Intro to the Demo site
5 |
6 | Installing an OS on a computer is a great step forward with a lot of difficulties. That's why a lot of people want to test an OS to be sure, that it's what they are looking for.
7 |
8 | [This demo website](https://avdan-os.github.io/Demo/) is created to show the advantages of AvdanOS and to give an opportunity for the community to try its light version in a browser or launch it on a PC without any preparations.
9 |
10 | That's why the demo website should be _lightweight_, _fast_, _multifunctional_ and _fail-safe_.
11 |
12 | In this documentation, you'll find out, how the demo website works and how you can contribute or modify it.
--------------------------------------------------------------------------------
/docs/demo/libdemo/Placeholder/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Placeholder Class",
3 | "position": 3,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Placeholder Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libdemo/Placeholder/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Placeholder
5 |
6 | `Placeholder` is used to create default window content. It's easy to use to save place in code and CSS if there's currently no content for a window.
7 |
8 | To add a placeholder, edit the code in `demo.js`.
9 |
10 | Example:
11 | ```js
12 | var MyApp = new Placeholder("MyApp", "src/images/demo/icons/Apps/MyAppIconName.png");
13 |
14 | apps_list = [
15 | // ...
16 |
17 | MyApp,
18 |
19 | // ...
20 | ]
21 | ```
22 |
23 | 
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Player Class",
3 | "position": 4,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Player Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Player
5 |
6 | `Player` is used to control music in the demo. It has a list of audios, that it uses to play music, set icons and show duration.
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/getDuration.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getDuration
5 |
6 | ```js
7 | static getDuration = ()
8 | ```
9 |
10 | `Player.getDuration` returns an integer of the current audio's duration.
11 |
12 | Example:
13 | ```js
14 | var duration = Player.getDuration();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/getIndex.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getIndex
5 |
6 | ```js
7 | static getIndex = ()
8 | ```
9 |
10 | `Player.getIndex` returns the current audio index. It may be used with `getList` to see more info about current audio.
11 |
12 | Example:
13 | ```js
14 | var audio_info = Player.getList()[Player.getIndex()];
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/getList.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getList
5 |
6 | ```js
7 | static getList = ()
8 | ```
9 |
10 | `Player.getList` returns an array with audio information.
11 |
12 | Example:
13 | ```js
14 | var audio_list = Player.getList();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/getTime.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getTime
5 |
6 | ```js
7 | static getTime = ()
8 | ```
9 |
10 | `Player.getTime` returns the current time position of the audio.
11 |
12 | Example:
13 | ```js
14 | var current_time = Player.getTime();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/getVolume.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getVolume
5 |
6 | ```js
7 | static getVolume = ()
8 | ```
9 |
10 | `Player.getVolume` returns player volume.
11 |
12 | Example:
13 | ```js
14 | var volume = Player.getVolume();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/next.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # next
5 |
6 | ```js
7 | static next = ()
8 | ```
9 |
10 | `Player.next` starts the next audio in the list. If it was the last audio, it will launch the first from the list.
11 |
12 | Example:
13 | ```js
14 | Player.next();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/paused.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # paused
5 |
6 | ```js
7 | static paused = ()
8 | ```
9 |
10 | `Player.paused` will return the current audio state.
11 |
12 | Example:
13 | ```js
14 | if (Player.paused()) {
15 | // ...
16 | }
17 | else {
18 | // ...
19 | }
20 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/prev.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # next
5 |
6 | ```js
7 | static next = ()
8 | ```
9 |
10 | `Player.prev` starts previous audio in the list. If it was the first audio, it will launch the last from the list.
11 |
12 | Example:
13 | ```js
14 | Player.prev();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/reload.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # reload
5 |
6 | ```js
7 | static reload = ()
8 | ```
9 |
10 | `Player.reload()` reloads the player, player widget and music windows.
11 |
12 | Example:
13 | ```js
14 | Player.setIndex(0).reload();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/setIndex.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # setIndex
5 |
6 | ```js
7 | static setIndex = pos
8 | ```
9 |
10 | `Player.setIndex` gets an integer and sets the audio index if the integer is in the list range.
11 |
12 | To apply changes you should force reload the player.
13 |
14 | Example:
15 | ```js
16 | Player.setIndex(0).reload();
17 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/setTime.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # setTime
5 |
6 | ```js
7 | static setTime = time
8 | ```
9 |
10 | `Player.setVolume` sets player time in seconds with a given integer (0..audio.duration).
11 |
12 | Example:
13 | ```js
14 | Player.setTime(70);
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/setVolume.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # setVolume
5 |
6 | ```js
7 | static setVolume = volume
8 | ```
9 |
10 | `Player.setVolume` sets player volume with a given integer (1..100).
11 |
12 | Example:
13 | ```js
14 | Player.setVolume(70);
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/Player/toggle.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # toggle
5 |
6 | ```js
7 | static toggle = ()
8 | ```
9 |
10 | `Player.toggle` is used to play/pause the player.
11 |
12 | Example:
13 | ```js
14 | Player.toggle();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdemo/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Demo library and info",
3 | "position": 5,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Demo library"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libdemo/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # About demo library
5 |
6 | Here is stored all the content and are called all generation functions.
7 |
8 | The Main last layer's calls are placed in `demo.js`. All of the window's content is split into `CSS/JS` files, like `lale.js/lale.css` and is loaded before `demo.js`.
9 |
10 | The best option is to create a class with info. For more info, you may look through existing classes.
--------------------------------------------------------------------------------
/docs/demo/libdemo/widget-template.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # Widget template & Adding your widget to the dock
5 |
6 | Window inserting:
53 | 54 | - drop a window in insert mode in another window to add as tab and tile 55 | - drop a window in insert mode in another window's topbar to add as tab without tilling 56 | 57 |
13 |
14 |
31 |
32 | It also executes start drag functions for `currentTarget` and `target`.
33 |
34 | Simple drag event:
35 | ```js
36 | currentTarget.addEventListener("mousedown", e => {
37 | DragAndDrop.add(e, `#${currentTarget.id}`, `#${target.id}`);
38 | });
39 | ```
40 | In this example, you can make an object movable without callback functions.
41 |
42 | Return function example:
43 | ```js
44 | const returnExample = (e, target, info) => {
45 | target.style.transition = "transform 0.1s ease-in-out";
46 | target.style.transform = null;
47 | }
48 | ```
49 |
50 | Every callback function gets `e` (event), `target` (`currentTarget/target` Object), `info` (`info` Object of target)
51 |
52 | This function smoothly returns an object to its position, but excludes smoothness on drag start.
53 |
54 | ```js
55 | const dropTransition = (e, target, info) => {
56 | target.style.transition = null;
57 | }
58 | ```
59 |
60 | Now we can upgrade our code:
61 | ```js
62 | currentTarget.addEventListener("mousedown", e => {
63 | DragAndDrop.add(e, `#${currentTarget.id}`, `#${target.id}`, undefined, dropTransition, undefined, undefined, undefined, returnExample);
64 | });
65 | ```
66 |
67 | If there's no function, just set it as `undefined`.
68 |
69 | `currentTarget` must be child of the `target` or even `target` itself. Otherwise, it can cause unpredictable behavior. Also, it's a possibility to create a remote manipulation functionality.
--------------------------------------------------------------------------------
/docs/demo/libdrag/click.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # Click
5 |
6 | ```js
7 | static click = (e, target, currentTarget_f, target_f)
8 | ```
9 |
10 | `DragAndDrop.click` is just an extended click event, that executes a function for `target` and `currentTarget` when `currentTarget` is clicked. Rarely used.
11 |
12 | An example directly from demo website:
13 | ```js
14 | win_fullsize.addEventListener("click", e => {
15 | DragAndDrop.click(e, `#${win.id}`, undefined, fullsize);
16 | });
17 | ```
18 |
19 | When you click the fullscreen button on the window, it becomes bigger.
20 |
21 | This function just makes sometimes code faster and smaller.
--------------------------------------------------------------------------------
/docs/demo/libdrag/drop.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # drop
5 |
6 | ```js
7 | static drop = (e, target)
8 | ```
9 |
10 | `DragAndDrop.drop` is executed on `mouseup` event and uses `info` to end drag.
11 |
12 | `target` is required to catch `info` Object from `dragList`.
13 |
14 | Example:
15 | ```js
16 | window.addEventListener("mouseup", e => {
17 | DragAndDrop.drop(e, `#${target}`);
18 | });
19 | ```
20 |
21 | The second argument should be the same as the third in `add`.
--------------------------------------------------------------------------------
/docs/demo/libdrag/dropAll.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # dropAll
5 |
6 | ```js
7 | static dropAll = e
8 | ```
9 |
10 | `DragAndDrop.dropAll` is used to drop all objects as if it was `drop` for every `dragList` item, but in `add` you can specify a `drop_f` function, that will be executed only in that case.
11 |
12 | It's mostly used to drop all objects if the cursor leaves the page while dragging something to exclude unexpected behavior.
13 |
14 | Example:
15 | ```js
16 | demo_body.addEventListener("mouseleave", DragAndDrop.dropAll});
17 | ```
--------------------------------------------------------------------------------
/docs/demo/libdrag/get.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # get
5 |
6 | ```js
7 | static get = ()
8 | ```
9 |
10 | `DragAndDrop.get` is used to get private `dragList` to view all currently dragged Objects.
11 |
12 | Example:
13 | ```js
14 | var dragList = DragAndDrop.get(); // a clone of the private list
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libdrag/listen.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # listen
5 |
6 | ```js
7 | static listen = e
8 | ```
9 |
10 | `DragAndDrop.listen` controls all movements iterating through `dragList`. Theoretically, it can move many objects at the same time as long as they are in `dragList`.
11 |
12 | To drop all objects without end drop functions, you can `DragAndDrop.wipe()`, but better don't do it.
13 |
14 | To enable dragging on a page you have to specify drag listener.
15 |
16 | Example:
17 | ```js
18 | window.addEventListener("mousemove", DragAndDrop.listen);
19 | ```
20 |
21 | That's all. There should exist only one global drag listener. It can be any object, but remember, that all drag events will be possible only inside this object, so `window` is the best option.
22 |
23 | This function also executes real-time drag functions for `currentTarget` and `target` Object every move. These functions are stored in `dragList`, which you can [get](get) with a function.
--------------------------------------------------------------------------------
/docs/demo/libdrag/wipe.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # wipe
5 |
6 | ```js
7 | static wipe = ()
8 | ```
9 |
10 | `DragAndDrop.wipe` is used to wipe `dragList`. This is a hard variation of the `dropAll` method and it shouldn't be used directly from the code.
11 |
12 | Example:
13 | ```js
14 | DragAndDrop.wipe(); // all Objects just will be dropped in the place, where they were brought
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Appbar/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Appbar Class",
3 | "position": 4,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Appbar Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/Appbar/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Appbar
5 |
6 | `Appbar` class is used to fill the appbar and control apps in the dock.
7 |
8 | `set` is used to set apps in the appbar and `get` is used to get the list of the current apps.
9 |
10 | It also has two extra variables:
11 |
12 | 1. `Appbar.Split` is a variable, that holds a template for a split line.
13 |
14 | Example:
15 |
16 | ```js
17 | var apps_list = [
18 | // some apps before the line
19 |
20 | Appbar.Split,
21 |
22 | // some apps after the line
23 | ]
24 | ```
25 |
26 | 2. `Appbar.appbar` contains a string reference to the appbar element.
27 |
28 | Use it with `querySelector`.
--------------------------------------------------------------------------------
/docs/demo/libwin/Appbar/get.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # get
5 |
6 | ```js
7 | static get = ()
8 | ```
9 |
10 | `Appbar.get` returns an array of apps and their info.
11 |
12 | Example:
13 | ```js
14 | var apps_list = Appbar.get();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Appbar/set.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # set
5 |
6 | ```js
7 | static set = list_l
8 | ```
9 |
10 | `Appbar.set` looks for an Object defined in `Appbar.app_bar` and fills it with app Objects. It gets a list of apps with generation configs for each one.
11 |
12 | Example from the demo:
13 | ```js
14 | var apps_list = [
15 | {
16 | "title" : Filemanager.title, // window title
17 | "src" : Filemanager.src, // appbar/window icon
18 | "content" : Filemanager.content, // content for the window
19 | "extraClass" : Filemanager.extraClass // extra classes for window (optional)
20 | },
21 | {
22 | "content" : "hr"
23 | },
24 | {
25 | "title" : Messages.title,
26 | "src" : Messages.src,
27 | "content" : Messages.content,
28 | "listenerAdder" : Messages. // dynamic function for cloned apps
29 | }
30 | }
31 |
32 | Appbar.set(apps_list);
33 | ```
34 |
35 | It sets the internal apps list with the given list to use it via `get` independent from the initial variable and origin.
--------------------------------------------------------------------------------
/docs/demo/libwin/ContextMenu/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "ContextMenu Class",
3 | "position": 4,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "ContextMenu Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/ContextMenu/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About ContextMenu
5 |
6 | `ContextMenu` class is used to create a custom context menu for your app. It can be applied to any element or window, so you may create specific menus for any window and elements inside it.
7 |
8 | It can't be directly accessed. For more information and examples of how to add a context menu to the app, go [here](../../libdemo/window_template).
9 |
10 | Adding a context menu to an element:
11 | ```js
12 | anyElement.contextMenu = [
13 | ...ContextMenu.defaultMenu,
14 | {
15 | "type" : "plain", // type
16 | "icon" : ContextIcons.download, // icon object (svg)
17 | "text" : "Download" // text for label
18 | },
19 | {
20 | "type" : "split",
21 | },
22 | {
23 | "type" : "plain",
24 | "icon" : ContextIcons.close,
25 | "text" : "Close"
26 | },
27 | ]
28 | ```
29 |
30 | If there's no context menu for the element, `ContextMenu` loop will check the next element in the path.
31 |
32 | Example:
33 | Element -> Element Holder -> Your App -> Workspace -> Demo
34 |
35 | It will loop through the path array till it finds any context menu. By default, Demo will have a default context menu applied.
--------------------------------------------------------------------------------
/docs/demo/libwin/Keylogger/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Keylogger Class",
3 | "position": 8,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Keylogger Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/Keylogger/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Keylogger
5 |
6 | `Keylogger` class is used to check, which keys are held or to add some general keybindings.
7 |
8 | It also has `Keylogger.showKeys` variable. Set it `true` via console to see events info.
--------------------------------------------------------------------------------
/docs/demo/libwin/Keylogger/getKeys.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getKeys
5 |
6 | ```js
7 | static getKeys = ()
8 | ```
9 |
10 | `Keylogger.getKeys` returns an array of currently held keys.
11 |
12 | Example:
13 | ```js
14 | Keylogger.getKeys().includes(16);
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Keylogger/getList.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # getList
5 |
6 | ```js
7 | static getList = ()
8 | ```
9 |
10 | `Keylogger.getList` returns an array of currently added key events.
11 |
12 | Example:
13 | ```js
14 | var actions_list = Keylogger.getList();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Keylogger/press.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 |
5 | # press
6 |
7 | ```js
8 | static press = (keyCode, ...args)
9 | ```
10 |
11 | `Keylogger.press` adds a new action to the private list.
12 |
13 | You can add multiple functions per call.
14 |
15 | Functions from `...args` get `e` as event information and `info` as information about this actions configs.
16 |
17 | Example:
18 |
19 | ```js
20 | const sayHi = (e, info) => {
21 | var keys = Keylogger.getKeys();
22 | if (keys.includes(16)) {
23 | console.log(`Hi, you pressed Ctrl and ${e.code}`);
24 | }
25 | };
26 |
27 | const someonesSayHi = (e, info) => {
28 | var keys = Keylogger.getKeys();
29 | if (keys.includes(17)) {
30 | console.log(`Hi, you pressed Shift and ${e.code}`);
31 | }
32 | };
33 |
34 | Keylogger.press(32, sayHi, someonesSayHi); // on Ctrl + Space or Shift + Space it will output message
35 | ```
36 |
37 | Better avoid splitting actions into multiple functions too much.
38 |
--------------------------------------------------------------------------------
/docs/demo/libwin/Keylogger/unpress.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # unpress
5 |
6 | ```js
7 | static unpress = (keyCode, ...args)
8 | ```
9 |
10 | `Keylogger.unpress` is used to remove all actions with a key. You may add references to the functions you want to remove to save other actions.
11 |
12 | Example;
13 | ```js
14 | Keylogger.press(23, sayHi, someonesSayHi);
15 |
16 | // ...
17 |
18 | // Example 1 (remove all)
19 | Keylogger.unpress(23);
20 |
21 | // Example 2 (only sayHi)
22 | Keylogger.unpress(23, sayHi);
23 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Layer/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Layer Class",
3 | "position": 7,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Layer Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/Layer/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Layer
5 |
6 | `Layer` class is used to control the `z-index` value to set window visibility.
7 |
8 | `inc` is used to increment the current value and `get` is used to get it for your purposes.
9 |
10 | Don't forget to increment layer value after you finish.
--------------------------------------------------------------------------------
/docs/demo/libwin/Layer/get.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # get
5 |
6 | ```js
7 | static get = ()
8 | ```
9 |
10 | `Layer.get` returns an integer for `z-index`.
11 |
12 | Example:
13 | ```js
14 | win.style.zIndex = Layer.get();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Layer/inc.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # inc
5 |
6 | ```js
7 | static inc = ()
8 | ```
9 |
10 | `Layer.inc` is used to increment the `z-index` value. It should be used at the end of the window impact function.
11 |
12 | Example:
13 | ```js
14 | Layer.inc();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Scrollbar/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Scrollbar Class",
3 | "position": 5,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Scrollbar Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/Scrollbar/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Scrollbar
5 |
6 | The `Scrollbar` class is used to control the third dock element with widgets.
7 |
8 | `set` is used to set a widget in the scrollbar and `get` is used to get the current scrollbar list.
9 |
10 | It also has two extra variables:
11 |
12 | 1. `Appbar.scroll_bar` contains a string reference to the scrollbar element.
13 |
14 | Use it with `querySelector`.
--------------------------------------------------------------------------------
/docs/demo/libwin/Scrollbar/get.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # get
5 |
6 | ```js
7 | static get = ()
8 | ```
9 |
10 | `Scrollbar.get` returns an Object with the current widget index as `pos` and an array of widgets.
11 |
12 | Example:
13 | ```js
14 | var scroll_list = Scrollbar.get();
15 | var current_widget = scroll_list[scroll_list.pos];
16 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Scrollbar/set.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # set
5 |
6 | ```js
7 | static set = list_l
8 | ```
9 |
10 | `Scrollbar.set` looks for Object defined in `Scrollbar.scroll_bar` and fills dock element with a widget from `items` due to `pos` index.
11 |
12 | It also has a `wheel` event, that refreshes the scrollbar every time it's scrolled with Shift Holden.
13 |
14 | Example from the demo:
15 | ```js
16 | var scroll_list = {
17 | "pos" : 0,
18 | "items" : [
19 | weather_time,
20 | player_holder,
21 | ]
22 | }
23 |
24 | Scrollbar.set(scroll_list);
25 | ```
26 |
27 | It sets the internal widgets list with the given list to use it in `window.js` via `get` independent from the initial variable and origin.
28 |
29 | Scrollbar scrolling just changes `pos` and recreates the scrollbar.
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Window Class",
3 | "position": 3,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Window Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # About Window
5 |
6 | `Window` is used to control window spawning. It controls the main id to unite elements with windows and wraps content in windows.
7 |
8 | `get` is used to get the current id and `inc` is used as increment id, `make` creates a window Object and `close` is used to close a window.
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/close.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # close
5 |
6 | ```js
7 | static close = (e, ...args)
8 | ```
9 |
10 | `Window.close` is used to close windows. If Object is not a window, it will throw an `Error`.
11 |
12 | Example:
13 | ```js
14 | Window.close(e, win1, win2, ...); // e - event (can be undefined)
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/closeTab.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # closeTab
5 |
6 | ```js
7 | static closeTab = (...args)
8 | ```
9 |
10 | `Window.closeTab` is used to merge some windows into a single one. If any object from `...args` is not a tab, it will finish the loop and throw an `Error`.
11 |
12 | Example:
13 | ```js
14 | Window.closeTab(tab1, tab2, ...);
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/get.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # get
5 |
6 | ```js
7 | static get = ()
8 | ```
9 |
10 | `Window.get` returns current window id.
11 |
12 | ```js
13 | var current_id = Window.get();
14 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/inc.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # inc
5 |
6 | ```js
7 | static inc = ()
8 | ```
9 |
10 | `Window.inc` is used to increment window id. It's used after window creation.
11 |
12 | Example:
13 | ```js
14 | Window.inc();
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/make.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # make
5 |
6 | ```js
7 | static make = (content, icon_src, title, extraClass, contextMenu, makeClone, addPanel = true, addResize = true, onclone = async content => {}) => {
8 | ```
9 |
10 | `Window.make` returns a window Object, that can be added to the page. Before adding it you can modify it.
11 |
12 | ## Arguments:
13 |
14 | Info:
15 | 16 | - `currentTarget` (id/class) 17 | - `target` (id/class) 18 | - `currentTarget_in_f` (start drag function) 19 | - `target_in_f` (start drag function) 20 | - `currentTarget_f` (while drag function) 21 | - `target_f` (while drag function) 22 | - `currentTarget_out_f` (end drag function) 23 | - `target_out_f` (end drag function) 24 | - `drop_f` (out of bounds function) 25 | - `modifyX` (default true) (flag to block X axis movement) 26 | - `modifyY` (default true) (flag to block Y axis movement) 27 | - `extraX` (default 0) (extra X offset (for resize purposes)) 28 | - `extraY` (default 0) (extra Y offset (for resize purposes)) 29 | 30 |
15 |
26 |
27 | Content
16 | 17 | `content` can be any element like 18 | ```js 19 | var content = document.createElement("div"); 20 | ``` 21 | You can modify it and send it as an argument. 22 | 23 | For more details check the template sections in the demo library. 24 | 25 |
28 |
33 |
34 | Icon Source
29 | 30 | `icon_src` is an URL to the app icon. 31 | 32 |
35 |
40 |
41 | Title
36 | 37 | Window title. 38 | 39 |
42 |
50 |
51 | Extra Classes
43 | 44 | `extraClass` is an array of strings. All strings will be added to the generated window as classes. 45 | ```js 46 | ["filemanager-window", "wide-window"] 47 | ``` 48 | 49 |
52 |
79 |
80 | Context menu
53 | 54 | Any window may have a custom context menu. It's optional. 55 | 56 | If there's no context menu, demo will use the default one. 57 | 58 | Example: 59 | ```js 60 | [ 61 | ...ContextMenu.defaultMenu, 62 | { 63 | "type" : "plain", 64 | "icon" : ContextIcons.download, 65 | "text" : "Download" 66 | }, 67 | { 68 | "type" : "split", 69 | }, 70 | { 71 | "type" : "plain", 72 | "icon" : ContextIcons.close, 73 | "text" : "Close" 74 | }, 75 | ] 76 | ``` 77 | 78 |
81 |
88 |
89 | Make Clone
82 | 83 | Bool flag. It's used to clone content and add it to multiple windows. (cloning objects makes them static and drops events). 84 | 85 | For more details check `Listener Adder`. 86 | 87 |
90 |
95 |
96 | Add Panel
91 | 92 | Bool flag. `false` to disable topbar. It will also change window class from `window` to `static-window`. 93 | 94 |
97 |
102 |
103 | Add Resize
98 | 99 | Bool flag. `false` to disable resizing. 100 | 101 |
104 |
111 |
112 | Simple window example:
113 |
114 | ```js
115 | Window.make(filemanager_content, "src/image/filemanager.jpg", "Filemanager");
116 | ```
117 |
118 | Adding window to the `body`:
119 | ```js
120 | Workspace.add(Window.make(filemanager_content, "src/image/filemanager.jpg", "Filemanager"));
121 | ```
122 |
123 | For more info about how to create an app, go to the template sections in the demo library.
--------------------------------------------------------------------------------
/docs/demo/libwin/Window/merge.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # merge
5 |
6 | ```js
7 | static merge = (main_win, ...args)
8 | ```
9 |
10 | `Window.merge` is used to merge some windows into a single one. If `main_win` is not a window, it will throw an `Error`.
11 |
12 | You may mix windows with boolean flags to change tilling visibility after merging.
13 |
14 | By default, all merged windows are visible.
15 |
16 | Example:
17 | ```js
18 | // Merge win1 and win2 with main_win
19 |
20 | // win1 will be visible after merging and win2 will be hidden, but may be accessed via a tab in a top bar
21 | Window.merge(main_win, win1, false, win2, ...);
22 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Workspace/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Workspace Class",
3 | "position": 6,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Workspace Class"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/Workspace/add.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # add
5 |
6 | ```js
7 | static add = (..args)
8 | ```
9 |
10 | `Workspace.add` can add multiple windows to the current workspace.
11 |
12 | ```js
13 | Workspace.add(anyWindow1, anyWindow2, ...);
14 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Workspace/get.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # get
5 |
6 | ```js
7 | static get = ()
8 | ```
9 |
10 | `Workspace.get` returns current workspace number. It can be used with id.
11 |
12 | Example:
13 | ```js
14 | var workspace = document.querySelector(`#workspace${Workspace.get()}`);
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/Workspace/set.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 3
3 | ---
4 | # set
5 |
6 | ```js
7 | static set = ws_num
8 | ```
9 |
10 | `Workspace.set` creates or switches to the workspace by `ws_num` number. If the workspace is empty, it will be erased, otherwise, it will switch to an existing one.
11 |
12 | Example:
13 | ```js
14 | Workspace.set(2).add(anyWindow);
15 | ```
--------------------------------------------------------------------------------
/docs/demo/libwin/_category_.json:
--------------------------------------------------------------------------------
1 | {
2 | "label": "Window Library",
3 | "position": 4,
4 | "link": {
5 | "type": "generated-index",
6 | "title": "Window Library"
7 | }
8 | }
--------------------------------------------------------------------------------
/docs/demo/libwin/about.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 | # About windows
5 |
6 | Any Object can be considered as a window if it has a `win-tab`, `content-holder` and `icon-block` and all with the same `win_num_g` id number.
7 |
8 | You can spawn embedded windows using this by calling `makeWindow` and modifying its output.
9 |
10 | All `content-holder` Objects are in the window's `container`. This gives a tilling opportunity.
11 |
12 | All `icon-block` Objects are between `container` and `wl`.
13 |
14 | All `win-tab` Objects are in the `tab-holder` inserted before the `tab-add` Object.
15 |
16 | Dock underlines are connected with windows via `win_id` id, which is used while generation in `Appbar`.
17 |
18 | Every window generation means incrementing this variable (`win_id`).
19 |
20 | 
21 |
22 | `icon-block` Objects are used to show icons in insert mode. They can be blank.
23 |
24 | `content-holder` is used to limit the content size and to give the possibility to move it in different windows.
25 |
26 | `win-tab` is used to manipulate the window in inserted mode.
--------------------------------------------------------------------------------
/docs/intro.md:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 2
3 | ---
4 |
5 | # Tutorial Intro
6 |
7 | Let's discover **Docusaurus in less than 5 minutes**.
8 |
9 | ## Getting Started
10 |
11 | Get started by **creating a new site**.
12 |
13 | Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14 |
15 | ### What you'll need
16 |
17 | - [Node.js](https://nodejs.org/en/download/) version 14 or above:
18 | - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
19 |
20 | ## Generate a new site
21 |
22 | Generate a new Docusaurus site using the **classic template**.
23 |
24 | The classic template will automatically be added to your project after you run the command:
25 |
26 | ```bash
27 | npm init docusaurus@latest my-website classic
28 | ```
29 |
30 | You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
31 |
32 | The command also installs all necessary dependencies you need to run Docusaurus.
33 |
34 | ## Start your site
35 |
36 | Run the development server:
37 |
38 | ```bash
39 | cd my-website
40 | npm run start
41 | ```
42 |
43 | The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
44 |
45 | The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
46 |
47 | Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
48 |
--------------------------------------------------------------------------------
/docs/nadva/navda-intro.mdx:
--------------------------------------------------------------------------------
1 | ---
2 | sidebar_position: 1
3 | ---
4 | # Intro to Navda
5 |
6 | Listener Adder
105 | 106 | `listenerAdder` is a function, that gets `content` (after cloning). You can modify this content and it will be applied to the generated window. 107 | 108 | It allows us to overpass cloning limitations and make windows dynamic. 109 | 110 |', 121 | }, 122 | { 123 | href: 'https://github.com/Avdan-OS/docsite', 124 | label: 'Help Us Translate', 125 | }, 126 | ], 127 | }, 128 | ], 129 | }, 130 | footer: { 131 | style: 'dark', 132 | links: [ 133 | { 134 | title: 'Docs', 135 | items: [ 136 | { 137 | label: 'Overview', 138 | to: '/docs/intro', 139 | }, 140 | { 141 | label: 'Navda', 142 | to: '/navda/navda-intro', 143 | }, 144 | { 145 | label: 'Demo', 146 | to: '/demo/demo-intro', 147 | }, 148 | ], 149 | }, 150 | { 151 | title: 'Community', 152 | items: [ 153 | { 154 | label: 'Discord', 155 | href: 'https://avdanos.org/discord', 156 | }, 157 | { 158 | label: 'YouTube', 159 | href: 'https://www.youtube.com/channel/UCHLCBj83J7bR82HwjhCJusA', 160 | }, 161 | { 162 | label: 'Twitter', 163 | href: 'https://twitter.com/avdan_os', 164 | }, 165 | { 166 | label: 'Instagram', 167 | href: 'https://www.instagram.com/avdanos_/', 168 | }, 169 | { 170 | label: 'Reddit', 171 | href: 'https://www.reddit.com/r/AvdanOS/', 172 | }, 173 | ], 174 | }, 175 | { 176 | title: 'More', 177 | items: [ 178 | // { 179 | // label: 'Blog', 180 | // href: '/blog', 181 | // }, 182 | { 183 | label: 'Our Website', 184 | href: 'https://avdanos.com/', 185 | }, 186 | { 187 | label: 'GitHub', 188 | href: 'https://github.com/Avdan-OS/', 189 | }, 190 | { 191 | label: 'Download', 192 | href: 'https://avdanos.com/downloads', 193 | }, 194 | ], 195 | }, 196 | ], 197 | copyright: `Copyright © ${new Date().getFullYear()} Avdan OS Community. Built with Docusaurus.`, 198 | }, 199 | prism: { 200 | theme: lightCodeTheme, 201 | darkTheme: darkCodeTheme, 202 | }, 203 | }), 204 | }; 205 | 206 | module.exports = config; 207 | -------------------------------------------------------------------------------- /i18n/en/code.json: -------------------------------------------------------------------------------- 1 | { 2 | "Get Started!": { 3 | "message": "Get Started!" 4 | }, 5 | "Everyone knows dock/task bar. We got a brand new dock, with more features than ever before.": { 6 | "message": "Everyone knows dock/task bar. We got a brand new dock, with more features than ever before." 7 | }, 8 | "Drag and drop is the easiest way to transfer anything on your computer. We make it intuitive and easy to use.": { 9 | "message": "Drag and drop is the easiest way to transfer anything on your computer. We make it intuitive and easy to use." 10 | }, 11 | "This file manager keeps you organized and productive. Find your files the instant you need it.": { 12 | "message": "This file manager keeps you organized and productive. Find your files the instant you need it." 13 | }, 14 | "Want to do many tasks at a time? We know you and we got you. It's now not only multitasking, it's organized multitasking.": { 15 | "message": "Want to do many tasks at a time? We know you and we got you. It's now not only multitasking, it's organized multitasking." 16 | }, 17 | "Context menu didn't change for multiple decades now. We are tired of a long list of items, and hey why not make it a circle? Don't like it? You can switch it back in settings!": { 18 | "message": "Context menu didn't change for multiple decades now. We are tired of a long list of items, and hey why not make it a circle? Don't like it? You can switch it back in settings!" 19 | }, 20 | "With a list of presets determined from you apps, easily get to work with the perfect window layout. Not enough? Change it in the settings.": { 21 | "message": "With a list of presets determined from you apps, easily get to work with the perfect window layout. Not enough? Change it in the settings." 22 | }, 23 | "theme.ErrorPageContent.title": { 24 | "message": "This page crashed.", 25 | "description": "The title of the fallback page when the page crashed" 26 | }, 27 | "theme.ErrorPageContent.tryAgain": { 28 | "message": "Try again", 29 | "description": "The label of the button to try again when the page crashed" 30 | }, 31 | "theme.NotFound.title": { 32 | "message": "Page Not Found", 33 | "description": "The title of the 404 page" 34 | }, 35 | "theme.NotFound.p1": { 36 | "message": "We could not find what you were looking for.", 37 | "description": "The first paragraph of the 404 page" 38 | }, 39 | "theme.NotFound.p2": { 40 | "message": "Please contact the owner of the site that linked you to the original URL and let them know their link is broken.", 41 | "description": "The 2nd paragraph of the 404 page" 42 | }, 43 | "theme.AnnouncementBar.closeButtonAriaLabel": { 44 | "message": "Close", 45 | "description": "The ARIA label for close button of announcement bar" 46 | }, 47 | "theme.blog.archive.title": { 48 | "message": "Archive", 49 | "description": "The page & hero title of the blog archive page" 50 | }, 51 | "theme.blog.archive.description": { 52 | "message": "Archive", 53 | "description": "The page & hero description of the blog archive page" 54 | }, 55 | "theme.BackToTopButton.buttonAriaLabel": { 56 | "message": "Scroll back to top", 57 | "description": "The ARIA label for the back to top button" 58 | }, 59 | "theme.blog.paginator.navAriaLabel": { 60 | "message": "Blog list page navigation", 61 | "description": "The ARIA label for the blog pagination" 62 | }, 63 | "theme.blog.paginator.newerEntries": { 64 | "message": "Newer Entries", 65 | "description": "The label used to navigate to the newer blog posts page (previous page)" 66 | }, 67 | "theme.blog.paginator.olderEntries": { 68 | "message": "Older Entries", 69 | "description": "The label used to navigate to the older blog posts page (next page)" 70 | }, 71 | "theme.blog.post.readingTime.plurals": { 72 | "message": "One min read|{readingTime} min read", 73 | "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" 74 | }, 75 | "theme.blog.post.readMoreLabel": { 76 | "message": "Read more about {title}", 77 | "description": "The ARIA label for the link to full blog posts from excerpts" 78 | }, 79 | "theme.blog.post.readMore": { 80 | "message": "Read More", 81 | "description": "The label used in blog post item excerpts to link to full blog posts" 82 | }, 83 | "theme.blog.post.paginator.navAriaLabel": { 84 | "message": "Blog post page navigation", 85 | "description": "The ARIA label for the blog posts pagination" 86 | }, 87 | "theme.blog.post.paginator.newerPost": { 88 | "message": "Newer Post", 89 | "description": "The blog post button label to navigate to the newer/previous post" 90 | }, 91 | "theme.blog.post.paginator.olderPost": { 92 | "message": "Older Post", 93 | "description": "The blog post button label to navigate to the older/next post" 94 | }, 95 | "theme.blog.post.plurals": { 96 | "message": "One post|{count} posts", 97 | "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" 98 | }, 99 | "theme.blog.tagTitle": { 100 | "message": "{nPosts} tagged with \"{tagName}\"", 101 | "description": "The title of the page for a blog tag" 102 | }, 103 | "theme.tags.tagsPageLink": { 104 | "message": "View All Tags", 105 | "description": "The label of the link targeting the tag list page" 106 | }, 107 | "theme.colorToggle.ariaLabel": { 108 | "message": "Switch between dark and light mode (currently {mode})", 109 | "description": "The ARIA label for the navbar color mode toggle" 110 | }, 111 | "theme.colorToggle.ariaLabel.mode.dark": { 112 | "message": "dark mode", 113 | "description": "The name for the dark color mode" 114 | }, 115 | "theme.colorToggle.ariaLabel.mode.light": { 116 | "message": "light mode", 117 | "description": "The name for the light color mode" 118 | }, 119 | "theme.docs.breadcrumbs.home": { 120 | "message": "Home page", 121 | "description": "The ARIA label for the home page in the breadcrumbs" 122 | }, 123 | "theme.docs.breadcrumbs.navAriaLabel": { 124 | "message": "Breadcrumbs", 125 | "description": "The ARIA label for the breadcrumbs" 126 | }, 127 | "theme.docs.DocCard.categoryDescription": { 128 | "message": "{count} items", 129 | "description": "The default description for a category card in the generated index about how many items this category includes" 130 | }, 131 | "theme.docs.paginator.navAriaLabel": { 132 | "message": "Docs pages navigation", 133 | "description": "The ARIA label for the docs pagination" 134 | }, 135 | "theme.docs.paginator.previous": { 136 | "message": "Previous", 137 | "description": "The label used to navigate to the previous doc" 138 | }, 139 | "theme.docs.paginator.next": { 140 | "message": "Next", 141 | "description": "The label used to navigate to the next doc" 142 | }, 143 | "theme.docs.tagDocListPageTitle.nDocsTagged": { 144 | "message": "One doc tagged|{count} docs tagged", 145 | "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" 146 | }, 147 | "theme.docs.tagDocListPageTitle": { 148 | "message": "{nDocsTagged} with \"{tagName}\"", 149 | "description": "The title of the page for a docs tag" 150 | }, 151 | "theme.docs.versionBadge.label": { 152 | "message": "Version: {versionLabel}" 153 | }, 154 | "theme.docs.versions.unreleasedVersionLabel": { 155 | "message": "This is unreleased documentation for {siteTitle} {versionLabel} version.", 156 | "description": "The label used to tell the user that he's browsing an unreleased doc version" 157 | }, 158 | "theme.docs.versions.unmaintainedVersionLabel": { 159 | "message": "This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.", 160 | "description": "The label used to tell the user that he's browsing an unmaintained doc version" 161 | }, 162 | "theme.docs.versions.latestVersionSuggestionLabel": { 163 | "message": "For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).", 164 | "description": "The label used to tell the user to check the latest version" 165 | }, 166 | "theme.docs.versions.latestVersionLinkLabel": { 167 | "message": "latest version", 168 | "description": "The label used for the latest version suggestion link label" 169 | }, 170 | "theme.common.editThisPage": { 171 | "message": "Edit this page", 172 | "description": "The link label to edit the current page" 173 | }, 174 | "theme.common.headingLinkTitle": { 175 | "message": "Direct link to heading", 176 | "description": "Title for link to heading" 177 | }, 178 | "theme.lastUpdated.atDate": { 179 | "message": " on {date}", 180 | "description": "The words used to describe on which date a page has been last updated" 181 | }, 182 | "theme.lastUpdated.byUser": { 183 | "message": " by {user}", 184 | "description": "The words used to describe by who the page has been last updated" 185 | }, 186 | "theme.lastUpdated.lastUpdatedAtBy": { 187 | "message": "Last updated{atDate}{byUser}", 188 | "description": "The sentence used to display when a page has been last updated, and by who" 189 | }, 190 | "theme.navbar.mobileVersionsDropdown.label": { 191 | "message": "Versions", 192 | "description": "The label for the navbar versions dropdown on mobile view" 193 | }, 194 | "theme.common.skipToMainContent": { 195 | "message": "Skip to main content", 196 | "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" 197 | }, 198 | "theme.tags.tagsListLabel": { 199 | "message": "Tags:", 200 | "description": "The label alongside a tag list" 201 | }, 202 | "theme.blog.sidebar.navAriaLabel": { 203 | "message": "Blog recent posts navigation", 204 | "description": "The ARIA label for recent posts in the blog sidebar" 205 | }, 206 | "theme.CodeBlock.copied": { 207 | "message": "Copied", 208 | "description": "The copied button label on code blocks" 209 | }, 210 | "theme.CodeBlock.copyButtonAriaLabel": { 211 | "message": "Copy code to clipboard", 212 | "description": "The ARIA label for copy code blocks button" 213 | }, 214 | "theme.CodeBlock.copy": { 215 | "message": "Copy", 216 | "description": "The copy button label on code blocks" 217 | }, 218 | "theme.CodeBlock.wordWrapToggle": { 219 | "message": "Toggle word wrap", 220 | "description": "The title attribute for toggle word wrapping button of code block lines" 221 | }, 222 | "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { 223 | "message": "Toggle the collapsible sidebar category '{label}'", 224 | "description": "The ARIA label to toggle the collapsible sidebar category" 225 | }, 226 | "theme.navbar.mobileLanguageDropdown.label": { 227 | "message": "Languages", 228 | "description": "The label for the mobile language switcher dropdown" 229 | }, 230 | "theme.TOCCollapsible.toggleButtonLabel": { 231 | "message": "On this page", 232 | "description": "The label used by the button on the collapsible TOC component" 233 | }, 234 | "theme.docs.sidebar.collapseButtonTitle": { 235 | "message": "Collapse sidebar", 236 | "description": "The title attribute for collapse button of doc sidebar" 237 | }, 238 | "theme.docs.sidebar.collapseButtonAriaLabel": { 239 | "message": "Collapse sidebar", 240 | "description": "The title attribute for collapse button of doc sidebar" 241 | }, 242 | "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { 243 | "message": "← Back to main menu", 244 | "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" 245 | }, 246 | "theme.docs.sidebar.expandButtonTitle": { 247 | "message": "Expand sidebar", 248 | "description": "The ARIA label and title attribute for expand button of doc sidebar" 249 | }, 250 | "theme.docs.sidebar.expandButtonAriaLabel": { 251 | "message": "Expand sidebar", 252 | "description": "The ARIA label and title attribute for expand button of doc sidebar" 253 | } 254 | } 255 | -------------------------------------------------------------------------------- /i18n/en/docusaurus-plugin-content-blog/options.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": { 3 | "message": "Blog", 4 | "description": "The title for the blog used in SEO" 5 | }, 6 | "description": { 7 | "message": "Blog", 8 | "description": "The description for the blog used in SEO" 9 | }, 10 | "sidebar.title": { 11 | "message": "Recent posts", 12 | "description": "The label for the left sidebar" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /i18n/en/docusaurus-plugin-content-docs-nadva/current.json: -------------------------------------------------------------------------------- 1 | { 2 | "version.label": { 3 | "message": "Next", 4 | "description": "The label for version current" 5 | }, 6 | "sidebar.tutorialSidebar.category.Multitasking in AvdanOS": { 7 | "message": "Multitasking in AvdanOS", 8 | "description": "The label for category Multitasking in AvdanOS in sidebar tutorialSidebar" 9 | }, 10 | "sidebar.tutorialSidebar.category.Multitasking in AvdanOS.link.generated-index.title": { 11 | "message": "Multitasking", 12 | "description": "The generated-index page title for category Multitasking in AvdanOS in sidebar tutorialSidebar" 13 | }, 14 | "sidebar.tutorialSidebar.category.Personalization": { 15 | "message": "Personalization", 16 | "description": "The label for category Personalization in sidebar tutorialSidebar" 17 | }, 18 | "sidebar.tutorialSidebar.category.Personalization.link.generated-index.title": { 19 | "message": "Theming and customizing the OS.", 20 | "description": "The generated-index page title for category Personalization in sidebar tutorialSidebar" 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /i18n/en/docusaurus-plugin-content-docs/current.json: -------------------------------------------------------------------------------- 1 | { 2 | "version.label": { 3 | "message": "Next", 4 | "description": "The label for version current" 5 | }, 6 | "sidebar.tutorialSidebar.category.Contributing to AvdanOS Project": { 7 | "message": "Contributing to AvdanOS Project", 8 | "description": "The label for category Contributing to AvdanOS Project in sidebar tutorialSidebar" 9 | }, 10 | "sidebar.tutorialSidebar.category.Contributing to AvdanOS Project.link.generated-index.title": { 11 | "message": "Contributing to AvdanOS Project", 12 | "description": "The generated-index page title for category Contributing to AvdanOS Project in sidebar tutorialSidebar" 13 | }, 14 | "sidebar.tutorialSidebar.category.Development": { 15 | "message": "Development", 16 | "description": "The label for category Development in sidebar tutorialSidebar" 17 | }, 18 | "sidebar.tutorialSidebar.category.Development.link.generated-index.title": { 19 | "message": "Contributing to AvdanOS Development", 20 | "description": "The generated-index page title for category Development in sidebar tutorialSidebar" 21 | }, 22 | "sidebar.tutorialSidebar.category.Code Guidelines": { 23 | "message": "Code Guidelines", 24 | "description": "The label for category Code Guidelines in sidebar tutorialSidebar" 25 | }, 26 | "sidebar.tutorialSidebar.category.Code Guidelines.link.generated-index.title": { 27 | "message": "Code Guidelines", 28 | "description": "The generated-index page title for category Code Guidelines in sidebar tutorialSidebar" 29 | }, 30 | "sidebar.tutorialSidebar.category.Documentation": { 31 | "message": "Documentation", 32 | "description": "The label for category Documentation in sidebar tutorialSidebar" 33 | }, 34 | "sidebar.tutorialSidebar.category.Documentation.link.generated-index.title": { 35 | "message": "Contributing to AvdanOS Documentation", 36 | "description": "The generated-index page title for category Documentation in sidebar tutorialSidebar" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /i18n/en/docusaurus-theme-classic/footer.json: -------------------------------------------------------------------------------- 1 | { 2 | "link.title.Docs": { 3 | "message": "Docs", 4 | "description": "The title of the footer links column with title=Docs in the footer" 5 | }, 6 | "link.title.Community": { 7 | "message": "Community", 8 | "description": "The title of the footer links column with title=Community in the footer" 9 | }, 10 | "link.title.More": { 11 | "message": "More", 12 | "description": "The title of the footer links column with title=More in the footer" 13 | }, 14 | "link.item.label.Overview": { 15 | "message": "Overview", 16 | "description": "The label of footer link with label=Overview linking to /docs/intro" 17 | }, 18 | "link.item.label.Contribute": { 19 | "message": "Contribute", 20 | "description": "The label of footer link with label=Contribute linking to /docs/category/contributing-to-avdanos-project" 21 | }, 22 | "link.item.label.FAQ": { 23 | "message": "FAQ", 24 | "description": "The label of footer link with label=FAQ linking to /docs/faq" 25 | }, 26 | "link.item.label.Navda": { 27 | "message": "Navda", 28 | "description": "The label of footer link with label=Navda linking to /navda/navda-intro" 29 | }, 30 | "link.item.label.Multitasking": { 31 | "message": "Multitasking", 32 | "description": "The label of footer link with label=Multitasking linking to /navda/category/multitasking-in-avdanos" 33 | }, 34 | "link.item.label.Personalization": { 35 | "message": "Personalization", 36 | "description": "The label of footer link with label=Personalization linking to /navda/category/personalization" 37 | }, 38 | "link.item.label.Discord": { 39 | "message": "Discord", 40 | "description": "The label of footer link with label=Discord linking to https://discord.gg/avdanos" 41 | }, 42 | "link.item.label.YouTube": { 43 | "message": "YouTube", 44 | "description": "The label of footer link with label=YouTube linking to https://www.youtube.com/channel/UCHLCBj83J7bR82HwjhCJusA" 45 | }, 46 | "link.item.label.Twitter": { 47 | "message": "Twitter", 48 | "description": "The label of footer link with label=Twitter linking to https://twitter.com/avdan_os" 49 | }, 50 | "link.item.label.Instagram": { 51 | "message": "Instagram", 52 | "description": "The label of footer link with label=Instagram linking to https://www.instagram.com/avdanos_/" 53 | }, 54 | "link.item.label.Reddit": { 55 | "message": "Reddit", 56 | "description": "The label of footer link with label=Reddit linking to https://www.reddit.com/r/AvdanOS/" 57 | }, 58 | "link.item.label.Blog": { 59 | "message": "Blog", 60 | "description": "The label of footer link with label=Blog linking to /blog" 61 | }, 62 | "link.item.label.Our Website": { 63 | "message": "Our Website", 64 | "description": "The label of footer link with label=Our Website linking to https://avdanos.com/" 65 | }, 66 | "link.item.label.GitHub": { 67 | "message": "GitHub", 68 | "description": "The label of footer link with label=GitHub linking to https://github.com/Avdan-OS/" 69 | }, 70 | "link.item.label.Download": { 71 | "message": "Download", 72 | "description": "The label of footer link with label=Download linking to https://avdanos.com/downloads" 73 | }, 74 | "copyright": { 75 | "message": "© Copyright Avdan OS Contributors 2023. Built with Docusaurus.", 76 | "description": "The footer copyright" 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /i18n/en/docusaurus-theme-classic/navbar.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": { 3 | "message": "AvdanOS Docs", 4 | "description": "The title in the navbar" 5 | }, 6 | "item.label.Project AvdanOS": { 7 | "message": "Project AvdanOS", 8 | "description": "Navbar item with label Project AvdanOS" 9 | }, 10 | "item.label.Navda": { 11 | "message": "Navda", 12 | "description": "Navbar item with label Navda" 13 | } 14 | } 15 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "avdan-os-docs", 3 | "version": "0.0.0", 4 | "private": true, 5 | "scripts": { 6 | "docusaurus": "docusaurus", 7 | "start": "docusaurus start", 8 | "build": "docusaurus build", 9 | "swizzle": "docusaurus swizzle", 10 | "deploy": "docusaurus deploy", 11 | "clear": "docusaurus clear", 12 | "serve": "docusaurus serve", 13 | "write-translations": "docusaurus write-translations", 14 | "write-heading-ids": "docusaurus write-heading-ids" 15 | }, 16 | "dependencies": { 17 | "@docusaurus/core": "2.0.0-beta.21", 18 | "@docusaurus/preset-classic": "2.0.0-beta.21", 19 | "@mdx-js/react": "^1.6.22", 20 | "clsx": "^1.1.1", 21 | "prism-react-renderer": "^1.3.3", 22 | "react": "^17.0.2", 23 | "react-dom": "^17.0.2" 24 | }, 25 | "devDependencies": { 26 | "@docusaurus/module-type-aliases": "2.0.0-beta.21" 27 | }, 28 | "browserslist": { 29 | "production": [ 30 | ">0.5%", 31 | "not dead", 32 | "not op_mini all" 33 | ], 34 | "development": [ 35 | "last 1 chrome version", 36 | "last 1 firefox version", 37 | "last 1 safari version" 38 | ] 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /sidebar/apps.js: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * Creating a sidebar enables you to: 4 | - create an ordered group of docs 5 | - render a sidebar for each doc of that group 6 | - provide next/previous navigation 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | Create as many sidebars as you want. 9 | */ 10 | 11 | // @ts-check 12 | 13 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 14 | const sidebars = { 15 | // By default, Docusaurus generates a sidebar from the docs folder structure 16 | tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], 17 | 18 | // But you can create a sidebar manually 19 | /* 20 | tutorialSidebar: [ 21 | { 22 | type: 'category', 23 | label: 'Tutorial', 24 | items: ['hello'], 25 | }, 26 | ], 27 | */ 28 | }; 29 | 30 | module.exports = sidebars; -------------------------------------------------------------------------------- /sidebar/avdanos.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Creating a sidebar enables you to: 3 | - create an ordered group of docs 4 | - render a sidebar for each doc of that group 5 | - provide next/previous navigation 6 | 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | 9 | Create as many sidebars as you want. 10 | */ 11 | 12 | // @ts-check 13 | 14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 | const sidebars = { 16 | // By default, Docusaurus generates a sidebar from the docs folder structure 17 | tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], 18 | 19 | // But you can create a sidebar manually 20 | /* 21 | tutorialSidebar: [ 22 | { 23 | type: 'category', 24 | label: 'Tutorial', 25 | items: ['hello'], 26 | }, 27 | ], 28 | */ 29 | }; 30 | 31 | module.exports = sidebars; 32 | -------------------------------------------------------------------------------- /sidebar/demo.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Creating a sidebar enables you to: 3 | - create an ordered group of docs 4 | - render a sidebar for each doc of that group 5 | - provide next/previous navigation 6 | 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | 9 | Create as many sidebars as you want. 10 | */ 11 | 12 | // @ts-check 13 | 14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 | const sidebars = { 16 | // By default, Docusaurus generates a sidebar from the docs folder structure 17 | tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], 18 | 19 | // But you can create a sidebar manually 20 | /* 21 | tutorialSidebar: [ 22 | { 23 | type: 'category', 24 | label: 'Tutorial', 25 | items: ['hello'], 26 | }, 27 | ], 28 | */ 29 | }; 30 | 31 | module.exports = sidebars; -------------------------------------------------------------------------------- /sidebar/navda.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Creating a sidebar enables you to: 3 | - create an ordered group of docs 4 | - render a sidebar for each doc of that group 5 | - provide next/previous navigation 6 | 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | 9 | Create as many sidebars as you want. 10 | */ 11 | 12 | // @ts-check 13 | 14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 | const sidebars = { 16 | // By default, Docusaurus generates a sidebar from the docs folder structure 17 | tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], 18 | 19 | // But you can create a sidebar manually 20 | /* 21 | tutorialSidebar: [ 22 | { 23 | type: 'category', 24 | label: 'Tutorial', 25 | items: ['hello'], 26 | }, 27 | ], 28 | */ 29 | }; 30 | 31 | module.exports = sidebars; 32 | -------------------------------------------------------------------------------- /src/components/HomepageFeatures/index.js: -------------------------------------------------------------------------------- 1 | import React from 'react' 2 | import clsx from 'clsx' 3 | import styles from './styles.module.css' 4 | import Translate, { translate } from '@docusaurus/Translate' 5 | import navda_img from '../../../static/img/card-navda.png' 6 | import website_img from '../../../static/img/card-website.png' 7 | const ReposList = [ 8 | { 9 | title: 'Official Website', 10 | description: 11 | 'All the new Updates and Information about AvdanOS and Support.', 12 | imageUrl: website_img, 13 | githubUrl: 'https://github.com/Avdan-OS/Website', 14 | docUrl: '/website/website-overview', 15 | }, 16 | { 17 | title: 'Wayland Compositor', 18 | description: 'Meet Navda, the official Wayland Compositor for AvdanOS.', 19 | imageUrl: navda_img, 20 | githubUrl: 'https://github.com/Avdan-OS/Compositor', 21 | docUrl: '/navda/navda-intro', 22 | }, 23 | ] 24 | 25 | const RepoCard = ({ title, description, imageUrl, githubUrl, docUrl }) => { 26 | return ( 27 |
28 | 
29 |
38 |
39 | )
40 | }
41 |
42 | export default function HomepageFeatures() {
43 | return (
44 |
46 |
52 |
47 | {ReposList.map((props, idx) => (
48 |
51 |
13 |
22 |
23 | )
24 | }
--------------------------------------------------------------------------------
/src/components/notices/incomplete.js:
--------------------------------------------------------------------------------
1 | // @ts-ignore
2 | import React from "react";
3 | import Admonition from "@theme/Admonition";
4 |
5 | export default ({url}) => (
6 | 12 | Help us by contributing to it on our GitHub. 13 |
15 |
25 | {siteConfig.title}
16 |{siteConfig.tagline}
17 |
18 |
21 | Get Started!
22 |
23 |
24 |