Skip to content

Commit 1e40423

Browse files
ProzillaProzilla
committed
Docs: Added separate packages pages
1 parent ed98911 commit 1e40423

File tree

44 files changed

+401
-167
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+401
-167
lines changed

‎packages/apps/browser/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,15 @@ url: string;
6464

6565
## Links
6666

67-
- [Website/demo][website]
67+
- [Demo][demo]
68+
- [Docs][docs]
6869
- [GitHub][github]
6970
- [npm][npm]
7071
- [Discord][discord]
7172
- [Ko-fi][ko-fi]
7273

73-
[website]: https://os.prozilla.dev/browser
74+
[demo]: https://os.prozilla.dev/browser
75+
[docs]: https://os.prozilla.dev/docs/reference/apps/browser
7476
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/browser
7577
[npm]: https://www.npmjs.com/package/@prozilla-os/browser
7678
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/calculator/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,15 @@ function App() {
5555

5656
## Links
5757

58-
- [Website/demo][website]
58+
- [Demo][demo]
59+
- [Docs][docs]
5960
- [GitHub][github]
6061
- [npm][npm]
6162
- [Discord][discord]
6263
- [Ko-fi][ko-fi]
6364

64-
[website]: https://os.prozilla.dev/calculator
65+
[demo]: https://os.prozilla.dev/calculator
66+
[docs]: https://os.prozilla.dev/docs/reference/apps/calculator
6567
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/calculator
6668
[npm]: https://www.npmjs.com/package/@prozilla-os/calculator
6769
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/file-explorer/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,15 @@ onSelectionFinish: Function;
9090

9191
## Links
9292

93-
- [Website/demo][website]
93+
- [Demo][demo]
94+
- [Docs][docs]
9495
- [GitHub][github]
9596
- [npm][npm]
9697
- [Discord][discord]
9798
- [Ko-fi][ko-fi]
9899

99-
[website]: https://os.prozilla.dev/file-explorer
100+
[demo]: https://os.prozilla.dev/file-explorer
101+
[docs]: https://os.prozilla.dev/docs/reference/apps/file-explorer
100102
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/file-explorer
101103
[npm]: https://www.npmjs.com/package/@prozilla-os/file-explorer
102104
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/logic-sim/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,15 @@ function App() {
5555

5656
## Links
5757

58-
- [Website/demo][website]
58+
- [Demo][demo]
59+
- [Docs][docs]
5960
- [GitHub][github]
6061
- [npm][npm]
6162
- [Discord][discord]
6263
- [Ko-fi][ko-fi]
6364

64-
[website]: https://os.prozilla.dev/logic-sim
65+
[demo]: https://os.prozilla.dev/logic-sim
66+
[docs]: https://os.prozilla.dev/docs/reference/apps/logic-sim
6567
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/logic-sim
6668
[npm]: https://www.npmjs.com/package/@prozilla-os/logic-sim
6769
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/media-viewer/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,15 @@ file: VirtualFile;
6464

6565
## Links
6666

67-
- [Website/demo][website]
67+
- [Demo][demo]
68+
- [Docs][docs]
6869
- [GitHub][github]
6970
- [npm][npm]
7071
- [Discord][discord]
7172
- [Ko-fi][ko-fi]
7273

73-
[website]: https://os.prozilla.dev/media-viewer
74+
[demo]: https://os.prozilla.dev/media-viewer
75+
[docs]: https://os.prozilla.dev/docs/reference/apps/media-viewer
7476
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/media-viewer
7577
[npm]: https://www.npmjs.com/package/@prozilla-os/media-viewer
7678
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/settings/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,15 @@ tab: number;
6565

6666
## Links
6767

68-
- [Website/demo][website]
68+
- [Demo][demo]
69+
- [Docs][docs]
6970
- [GitHub][github]
7071
- [npm][npm]
7172
- [Discord][discord]
7273
- [Ko-fi][ko-fi]
7374

74-
[website]: https://os.prozilla.dev/settings
75+
[demo]: https://os.prozilla.dev/settings
76+
[docs]: https://os.prozilla.dev/docs/reference/apps/settings
7577
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/settings
7678
[npm]: https://www.npmjs.com/package/@prozilla-os/settings
7779
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/terminal/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,15 @@ input: string;
7070

7171
## Links
7272

73-
- [Website/demo][website]
73+
- [Demo][demo]
74+
- [Docs][docs]
7475
- [GitHub][github]
7576
- [npm][npm]
7677
- [Discord][discord]
7778
- [Ko-fi][ko-fi]
7879

79-
[website]: https://os.prozilla.dev/terminal
80+
[demo]: https://os.prozilla.dev/terminal
81+
[docs]: https://os.prozilla.dev/docs/reference/apps/terminal
8082
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/terminal
8183
[npm]: https://www.npmjs.com/package/@prozilla-os/terminal
8284
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/apps/text-editor/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,15 @@ mode: "view" | "edit";
7777

7878
## Links
7979

80-
- [Website/demo][website]
80+
- [Demo][demo]
81+
- [Docs][docs]
8182
- [GitHub][github]
8283
- [npm][npm]
8384
- [Discord][discord]
8485
- [Ko-fi][ko-fi]
8586

86-
[website]: https://os.prozilla.dev/text-editor
87+
[demo]: https://os.prozilla.dev/text-editor
88+
[docs]: https://os.prozilla.dev/docs/reference/apps/text-editor
8789
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/text-editor
8890
[npm]: https://www.npmjs.com/package/@prozilla-os/text-editor
8991
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/core/README.md‎

Lines changed: 42 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,43 @@ function App() {
4444

4545
<br />
4646

47-
### `<ProzillaOS>` props
47+
### Configuration
4848

4949
```tsx
50-
{
50+
interface ProzillaOSProps {
5151

5252
systemName: string,
5353

5454
tagLine: string,
5555

56+
skin: new Skin({
57+
58+
appIcons: Record<number, string> | undefined,
59+
60+
appNames: Record<number, string> | undefined,
61+
62+
wallpapers: string[],
63+
64+
defaultWallpaper: string,
65+
66+
fileIcons: {
67+
generic: string;
68+
info: string | undefined;
69+
text: string | undefined;
70+
code: string | undefined;
71+
},
72+
73+
folderIcons: {
74+
generic: string;
75+
images: string | undefined;
76+
text: string | undefined;
77+
link: string | undefined;
78+
},
79+
80+
loadStyleSheet: () => void | undefined
81+
82+
})
83+
5684
config: {
5785
apps: new AppsConfig({
5886

@@ -61,12 +89,6 @@ function App() {
6189
}),
6290
desktop: new DesktopConfig({
6391

64-
/** Array of URLs of wallpaper images */
65-
wallpapers: string[],
66-
67-
/** URL of default wallpaper image */
68-
defaultWallpaper: string,
69-
7092
/**
7193
* @default 1
7294
*/
@@ -79,6 +101,14 @@ function App() {
79101
defaultIconDirection: 0 | 1
80102

81103
}),
104+
misc: new MiscConfig({
105+
106+
/**
107+
* @default 250
108+
*/
109+
doubleClickDelay: number
110+
111+
})
82112
modals: new ModalsConfig({
83113

84114
/**
@@ -114,19 +144,6 @@ function App() {
114144
/** Google Analytics measurement ID */
115145
GAMeasurementId: string
116146

117-
}),
118-
virtualDrive: new VirtualDriveConfig({
119-
120-
fileIcon: string,
121-
infoFileIcon: string,
122-
textFileIcon: string,
123-
codeFileIcon: string,
124-
125-
folderIcon: string,
126-
imagesFolderIcon: string,
127-
textFolderIcon: string,
128-
folderLinkIcon: string
129-
130147
}),
131148
windows: new WindowsConfig({
132149

@@ -154,13 +171,15 @@ function App() {
154171

155172
## Links
156173

157-
- [Website/demo][website]
174+
- [Demo][demo]
175+
- [Docs][docs]
158176
- [GitHub][github]
159177
- [npm][npm]
160178
- [Discord][discord]
161179
- [Ko-fi][ko-fi]
162180

163-
[website]: https://os.prozilla.dev/
181+
[demo]: https://os.prozilla.dev/
182+
[docs]: https://os.prozilla.dev/docs/reference/core
164183
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/core
165184
[npm]: https://www.npmjs.com/package/@prozilla-os/core
166185
[discord]: https://discord.gg/JwbyQP4tdz

‎packages/demo/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
- [Discord][discord]
3636
- [Ko-fi][ko-fi]
3737

38-
[website]: https://os.prozilla.dev/
38+
[demo]: https://os.prozilla.dev/
3939
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/demo
4040
[discord]: https://discord.gg/JwbyQP4tdz
4141
[ko-fi]: https://ko-fi.com/prozilla

0 commit comments

Comments
 (0)