Docs: Added separate packages pages
This commit is contained in:
parent
ed989110ad
commit
1e40423032
44 changed files with 401 additions and 167 deletions
|
|
@ -64,13 +64,15 @@ url: string;
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/browser
|
[demo]: https://os.prozilla.dev/browser
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/browser
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/browser
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/browser
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/browser
|
[npm]: https://www.npmjs.com/package/@prozilla-os/browser
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -55,13 +55,15 @@ function App() {
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/calculator
|
[demo]: https://os.prozilla.dev/calculator
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/calculator
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/calculator
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/calculator
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/calculator
|
[npm]: https://www.npmjs.com/package/@prozilla-os/calculator
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -90,13 +90,15 @@ onSelectionFinish: Function;
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/file-explorer
|
[demo]: https://os.prozilla.dev/file-explorer
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/file-explorer
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/file-explorer
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/file-explorer
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/file-explorer
|
[npm]: https://www.npmjs.com/package/@prozilla-os/file-explorer
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -55,13 +55,15 @@ function App() {
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/logic-sim
|
[demo]: https://os.prozilla.dev/logic-sim
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/logic-sim
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/logic-sim
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/logic-sim
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/logic-sim
|
[npm]: https://www.npmjs.com/package/@prozilla-os/logic-sim
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -64,13 +64,15 @@ file: VirtualFile;
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/media-viewer
|
[demo]: https://os.prozilla.dev/media-viewer
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/media-viewer
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/media-viewer
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/media-viewer
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/media-viewer
|
[npm]: https://www.npmjs.com/package/@prozilla-os/media-viewer
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -65,13 +65,15 @@ tab: number;
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/settings
|
[demo]: https://os.prozilla.dev/settings
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/settings
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/settings
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/settings
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/settings
|
[npm]: https://www.npmjs.com/package/@prozilla-os/settings
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -70,13 +70,15 @@ input: string;
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/terminal
|
[demo]: https://os.prozilla.dev/terminal
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/terminal
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/terminal
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/terminal
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/terminal
|
[npm]: https://www.npmjs.com/package/@prozilla-os/terminal
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -77,13 +77,15 @@ mode: "view" | "edit";
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/text-editor
|
[demo]: https://os.prozilla.dev/text-editor
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/apps/text-editor
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/text-editor
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/apps/text-editor
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/text-editor
|
[npm]: https://www.npmjs.com/package/@prozilla-os/text-editor
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -44,15 +44,43 @@ function App() {
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
### `<ProzillaOS>` props
|
### Configuration
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
{
|
interface ProzillaOSProps {
|
||||||
|
|
||||||
systemName: string,
|
systemName: string,
|
||||||
|
|
||||||
tagLine: string,
|
tagLine: string,
|
||||||
|
|
||||||
|
skin: new Skin({
|
||||||
|
|
||||||
|
appIcons: Record<number, string> | undefined,
|
||||||
|
|
||||||
|
appNames: Record<number, string> | undefined,
|
||||||
|
|
||||||
|
wallpapers: string[],
|
||||||
|
|
||||||
|
defaultWallpaper: string,
|
||||||
|
|
||||||
|
fileIcons: {
|
||||||
|
generic: string;
|
||||||
|
info: string | undefined;
|
||||||
|
text: string | undefined;
|
||||||
|
code: string | undefined;
|
||||||
|
},
|
||||||
|
|
||||||
|
folderIcons: {
|
||||||
|
generic: string;
|
||||||
|
images: string | undefined;
|
||||||
|
text: string | undefined;
|
||||||
|
link: string | undefined;
|
||||||
|
},
|
||||||
|
|
||||||
|
loadStyleSheet: () => void | undefined
|
||||||
|
|
||||||
|
})
|
||||||
|
|
||||||
config: {
|
config: {
|
||||||
apps: new AppsConfig({
|
apps: new AppsConfig({
|
||||||
|
|
||||||
|
|
@ -61,12 +89,6 @@ function App() {
|
||||||
}),
|
}),
|
||||||
desktop: new DesktopConfig({
|
desktop: new DesktopConfig({
|
||||||
|
|
||||||
/** Array of URLs of wallpaper images */
|
|
||||||
wallpapers: string[],
|
|
||||||
|
|
||||||
/** URL of default wallpaper image */
|
|
||||||
defaultWallpaper: string,
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @default 1
|
* @default 1
|
||||||
*/
|
*/
|
||||||
|
|
@ -79,6 +101,14 @@ function App() {
|
||||||
defaultIconDirection: 0 | 1
|
defaultIconDirection: 0 | 1
|
||||||
|
|
||||||
}),
|
}),
|
||||||
|
misc: new MiscConfig({
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @default 250
|
||||||
|
*/
|
||||||
|
doubleClickDelay: number
|
||||||
|
|
||||||
|
})
|
||||||
modals: new ModalsConfig({
|
modals: new ModalsConfig({
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -114,19 +144,6 @@ function App() {
|
||||||
/** Google Analytics measurement ID */
|
/** Google Analytics measurement ID */
|
||||||
GAMeasurementId: string
|
GAMeasurementId: string
|
||||||
|
|
||||||
}),
|
|
||||||
virtualDrive: new VirtualDriveConfig({
|
|
||||||
|
|
||||||
fileIcon: string,
|
|
||||||
infoFileIcon: string,
|
|
||||||
textFileIcon: string,
|
|
||||||
codeFileIcon: string,
|
|
||||||
|
|
||||||
folderIcon: string,
|
|
||||||
imagesFolderIcon: string,
|
|
||||||
textFolderIcon: string,
|
|
||||||
folderLinkIcon: string
|
|
||||||
|
|
||||||
}),
|
}),
|
||||||
windows: new WindowsConfig({
|
windows: new WindowsConfig({
|
||||||
|
|
||||||
|
|
@ -154,13 +171,15 @@ function App() {
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/
|
[demo]: https://os.prozilla.dev/
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/core
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/core
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/core
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/core
|
[npm]: https://www.npmjs.com/package/@prozilla-os/core
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -35,7 +35,7 @@
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/
|
[demo]: https://os.prozilla.dev/
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/demo
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/demo
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
[ko-fi]: https://ko-fi.com/prozilla
|
[ko-fi]: https://ko-fi.com/prozilla
|
||||||
|
|
@ -1,9 +1,6 @@
|
||||||
import { defineConfig, HeadConfig } from "vitepress";
|
import { defineConfig, HeadConfig } from "vitepress";
|
||||||
|
import { packageReferenceItems, PACKAGES, packageSidebars } from "./packages.config";
|
||||||
const TITLE = "ProzillaOS Docs";
|
import { DESCRIPTION, IMAGE, LOCALE, TITLE } from "./meta.config";
|
||||||
const DESCRIPTION = "Documentation for ProzillaOS and its packages.";
|
|
||||||
const LOCALE = "en_US";
|
|
||||||
const IMAGE = "https://os.prozilla.dev/docs/prozilla-os-title-banner.png";
|
|
||||||
|
|
||||||
// https://vitepress.dev/reference/site-config
|
// https://vitepress.dev/reference/site-config
|
||||||
export default defineConfig({
|
export default defineConfig({
|
||||||
|
|
@ -64,75 +61,22 @@ export default defineConfig({
|
||||||
base: "/reference/",
|
base: "/reference/",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
text: "Overview",
|
text: "Reference",
|
||||||
items: [
|
items: [
|
||||||
{ text: "Configuration", link: "/configuration" },
|
{ text: "Configuration", link: "/configuration" },
|
||||||
{ text: "Packages", link: "/packages" },
|
|
||||||
{ text: "Glossary", link: "/glossary" },
|
{ text: "Glossary", link: "/glossary" },
|
||||||
]
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
text: "Classes",
|
text: "Packages",
|
||||||
base: "/reference/classes/",
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
items: [
|
||||||
{
|
{ text: "Overview", link: "/packages" },
|
||||||
text: "Apps",
|
...packageReferenceItems(PACKAGES)
|
||||||
base: "/reference/classes/apps/",
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: "App", link: "app" },
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: "Skins",
|
|
||||||
base: "/reference/classes/skins/",
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: "Skin", link: "skin" },
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: "System",
|
|
||||||
base: "/reference/classes/system/",
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: "AppsConfig", link: "apps-config" },
|
|
||||||
{ text: "DesktopConfig", link: "desktop-config" },
|
|
||||||
{ text: "MiscConfig", link: "misc-config" },
|
|
||||||
{ text: "ModalsConfig", link: "modals-config" },
|
|
||||||
{ text: "TaskbarConfig", link: "taskbar-config" },
|
|
||||||
{ text: "TrackingConfig", link: "tracking-config" },
|
|
||||||
{ text: "WindowsConfig", link: "windows-config" },
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: "Utils",
|
|
||||||
base: "/reference/classes/utils/",
|
|
||||||
collapsed: true,
|
|
||||||
items: [
|
|
||||||
{ text: "Vector2", link: "vector2" },
|
|
||||||
]
|
|
||||||
},
|
|
||||||
]
|
]
|
||||||
},
|
}
|
||||||
{
|
|
||||||
text: "Functions",
|
|
||||||
base: "/reference/functions/",
|
|
||||||
collapsed: false,
|
|
||||||
items: [
|
|
||||||
{ text: "Array", link: "/array" },
|
|
||||||
{ text: "Browser", link: "/browser" },
|
|
||||||
{ text: "Date", link: "/date" },
|
|
||||||
{ text: "Math", link: "/math" },
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
text: "Constants",
|
|
||||||
link: "constants"
|
|
||||||
},
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
...packageSidebars(PACKAGES),
|
||||||
},
|
},
|
||||||
|
|
||||||
editLink: {
|
editLink: {
|
||||||
|
|
|
||||||
4
packages/docs/.vitepress/meta.config.ts
Normal file
4
packages/docs/.vitepress/meta.config.ts
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
export const TITLE = "ProzillaOS Docs";
|
||||||
|
export const DESCRIPTION = "Documentation for ProzillaOS and its packages.";
|
||||||
|
export const LOCALE = "en_US";
|
||||||
|
export const IMAGE = "https://os.prozilla.dev/docs/prozilla-os-title-banner.png";
|
||||||
168
packages/docs/.vitepress/packages.config.ts
Normal file
168
packages/docs/.vitepress/packages.config.ts
Normal file
|
|
@ -0,0 +1,168 @@
|
||||||
|
import { DefaultTheme } from "vitepress";
|
||||||
|
|
||||||
|
export interface PackageData {
|
||||||
|
text: string;
|
||||||
|
link: string;
|
||||||
|
items?: DefaultTheme.SidebarItem[];
|
||||||
|
category: "Libraries" | "Standard apps" | "Non-standard apps";
|
||||||
|
};
|
||||||
|
|
||||||
|
export const PACKAGES: PackageData[] = [
|
||||||
|
{
|
||||||
|
text: "prozilla-os",
|
||||||
|
link: "prozilla-os",
|
||||||
|
category: "Libraries"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/core",
|
||||||
|
link: "core",
|
||||||
|
category: "Libraries",
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
text: "Classes",
|
||||||
|
base: "/reference/core/classes/",
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
text: "Apps",
|
||||||
|
base: "/reference/core/classes/apps/",
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: "App", link: "app" },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "System",
|
||||||
|
base: "/reference/core/classes/system/",
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: "AppsConfig", link: "apps-config" },
|
||||||
|
{ text: "DesktopConfig", link: "desktop-config" },
|
||||||
|
{ text: "MiscConfig", link: "misc-config" },
|
||||||
|
{ text: "ModalsConfig", link: "modals-config" },
|
||||||
|
{ text: "TaskbarConfig", link: "taskbar-config" },
|
||||||
|
{ text: "TrackingConfig", link: "tracking-config" },
|
||||||
|
{ text: "WindowsConfig", link: "windows-config" },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "Utils",
|
||||||
|
base: "/reference/core/classes/utils/",
|
||||||
|
collapsed: true,
|
||||||
|
items: [
|
||||||
|
{ text: "Vector2", link: "vector2" },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "Functions",
|
||||||
|
base: "/reference/core/functions/",
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ text: "Array", link: "/array" },
|
||||||
|
{ text: "Browser", link: "/browser" },
|
||||||
|
{ text: "Date", link: "/date" },
|
||||||
|
{ text: "Math", link: "/math" },
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "Constants",
|
||||||
|
link: "constants"
|
||||||
|
},
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/skins",
|
||||||
|
link: "skins",
|
||||||
|
category: "Libraries",
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
text: "Classes",
|
||||||
|
base: "/reference/skins/classes/",
|
||||||
|
collapsed: false,
|
||||||
|
items: [
|
||||||
|
{ text: "Skin", link: "skin" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/shared",
|
||||||
|
link: "shared",
|
||||||
|
category: "Libraries",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/calculator",
|
||||||
|
link: "apps/calculator",
|
||||||
|
category: "Standard apps",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/file-explorer",
|
||||||
|
link: "apps/file-explorer",
|
||||||
|
category: "Standard apps",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/media-viewer",
|
||||||
|
link: "apps/media-viewer",
|
||||||
|
category: "Standard apps",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/settings",
|
||||||
|
link: "apps/settings",
|
||||||
|
category: "Standard apps",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/terminal",
|
||||||
|
link: "apps/terminal",
|
||||||
|
category: "Standard apps",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
text: "@prozilla-os/logic-sim",
|
||||||
|
link: "apps/logic-sim",
|
||||||
|
category: "Non-standard apps",
|
||||||
|
}
|
||||||
|
];
|
||||||
|
|
||||||
|
export const packageSidebars = (packages: PackageData[]): DefaultTheme.Sidebar => {
|
||||||
|
const sidebar: DefaultTheme.Sidebar = {};
|
||||||
|
|
||||||
|
packages.forEach(({ text, link, items = [] }) => {
|
||||||
|
const base = `/reference/${link}/`;
|
||||||
|
sidebar[base] = {
|
||||||
|
base,
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
text,
|
||||||
|
items: [
|
||||||
|
{ text: "Info", link: "/" },
|
||||||
|
...items
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
return sidebar;
|
||||||
|
};
|
||||||
|
|
||||||
|
export const packageReferenceItems = (packages: PackageData[]): DefaultTheme.SidebarItem[] => {
|
||||||
|
const categories: Record<string, DefaultTheme.SidebarItem> = {};
|
||||||
|
|
||||||
|
packages.forEach(({ text, link, category }) => {
|
||||||
|
if (!Object.keys(categories).includes(category)) {
|
||||||
|
categories[category] = {
|
||||||
|
text: category,
|
||||||
|
collapsed: true,
|
||||||
|
items: []
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
categories[category].items?.push({
|
||||||
|
text,
|
||||||
|
link
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
return Object.values(categories);
|
||||||
|
};
|
||||||
7
packages/docs/src/reference/apps/browser/index.md
Normal file
7
packages/docs/src/reference/apps/browser/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/browser
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/browser/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/apps/calculator/index.md
Normal file
7
packages/docs/src/reference/apps/calculator/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/calculator
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/calculator/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/apps/file-explorer/index.md
Normal file
7
packages/docs/src/reference/apps/file-explorer/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/file-explorer
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/file-explorer/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/apps/logic-sim/index.md
Normal file
7
packages/docs/src/reference/apps/logic-sim/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/logic-sim
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/logic-sim/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/apps/media-viewer/index.md
Normal file
7
packages/docs/src/reference/apps/media-viewer/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/media-viewer
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/media-viewer/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/apps/settings/index.md
Normal file
7
packages/docs/src/reference/apps/settings/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/settings
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/settings/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/apps/terminal/index.md
Normal file
7
packages/docs/src/reference/apps/terminal/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/terminal
|
||||||
|
|
||||||
|
<!--@include: ../../../../../apps/terminal/README.md{13,}-->
|
||||||
|
|
@ -29,7 +29,7 @@ Tag line or short description of the system
|
||||||
Configurations for assets, stylesheets and other visual elements
|
Configurations for assets, stylesheets and other visual elements
|
||||||
|
|
||||||
- **Optional**
|
- **Optional**
|
||||||
- **Type:** [`Skin`](/reference/classes/skins/skin)
|
- **Type:** [`Skin`](/reference/core/skins/classes/skin)
|
||||||
- **Default:** `new Skin()`
|
- **Default:** `new Skin()`
|
||||||
|
|
||||||
### config
|
### config
|
||||||
|
|
@ -52,13 +52,13 @@ interface ConfigOptions {
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE] References
|
> [!NOTE] References
|
||||||
> - [AppsConfig](/reference/classes/system/apps-config)
|
> - [AppsConfig](/reference/core/classes/system/apps-config)
|
||||||
> - [DesktopConfig](/reference/classes/system/desktop-config)
|
> - [DesktopConfig](/reference/core/classes/system/desktop-config)
|
||||||
> - [MiscConfig](/reference/classes/system/misc-config)
|
> - [MiscConfig](/reference/core/classes/system/misc-config)
|
||||||
> - [ModalsConfig](/reference/classes/system/modals-config)
|
> - [ModalsConfig](/reference/core/classes/system/modals-config)
|
||||||
> - [TaskbarConfig](/reference/classes/system/taskbar-config)
|
> - [TaskbarConfig](/reference/core/classes/system/taskbar-config)
|
||||||
> - [TrackingConfig](/reference/classes/system/tracking-config)
|
> - [TrackingConfig](/reference/core/classes/system/tracking-config)
|
||||||
> - [WindowsConfig](/reference/classes/system/windows-config)
|
> - [WindowsConfig](/reference/core/classes/system/windows-config)
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ interface AppsConfigOptions {
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE] References
|
> [!NOTE] References
|
||||||
> - [App](/reference/classes/apps/app)
|
> - [App](/reference/core/classes/apps/app)
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
|
|
@ -33,4 +33,4 @@ interface AppsConfigOptions {
|
||||||
|
|
||||||
An array of applications
|
An array of applications
|
||||||
|
|
||||||
- **Type:** [`App[]`](../apps/app)
|
- **Type:** [`App[]`](/reference/core/classes/apps/app)
|
||||||
|
|
@ -26,7 +26,7 @@ interface ModalsConfigOptions {
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE] References
|
> [!NOTE] References
|
||||||
> - [Vector2](/reference/classes/utils/vector2)
|
> - [Vector2](/reference/core/classes/utils/vector2)
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
|
|
@ -34,12 +34,12 @@ interface ModalsConfigOptions {
|
||||||
|
|
||||||
Default size of a dialog box
|
Default size of a dialog box
|
||||||
|
|
||||||
- **Type:** [`Vector2`](/reference/classes/utils/vector2)
|
- **Type:** [`Vector2`](/reference/core/classes/utils/vector2)
|
||||||
- **Default:** `new Vector2(400, 200)`
|
- **Default:** `new Vector2(400, 200)`
|
||||||
|
|
||||||
### defaultFileSelectorSize
|
### defaultFileSelectorSize
|
||||||
|
|
||||||
Default size of a file selector
|
Default size of a file selector
|
||||||
|
|
||||||
- **Type:** [`Vector2`](/reference/classes/utils/vector2)
|
- **Type:** [`Vector2`](/reference/core/classes/utils/vector2)
|
||||||
- **Default:** `new Vector2(700, 400)`
|
- **Default:** `new Vector2(700, 400)`
|
||||||
|
|
@ -27,7 +27,7 @@ interface WindowsConfigOptions {
|
||||||
```
|
```
|
||||||
|
|
||||||
> [!NOTE] References
|
> [!NOTE] References
|
||||||
> - [Vector2](/reference/classes/utils/vector2)
|
> - [Vector2](/reference/core/classes/utils/vector2)
|
||||||
|
|
||||||
## Properties
|
## Properties
|
||||||
|
|
||||||
|
|
@ -49,7 +49,7 @@ A string that is placed between different parts of a window title
|
||||||
|
|
||||||
If the user's screen is smaller than these values, windows will always be maximized
|
If the user's screen is smaller than these values, windows will always be maximized
|
||||||
|
|
||||||
- **Type:** [`Vector2`](/reference/classes/utils/vector2)
|
- **Type:** [`Vector2`](/reference/core/classes/utils/vector2)
|
||||||
- **Default:** `new Vector2(350, 350)`
|
- **Default:** `new Vector2(350, 350)`
|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
7
packages/docs/src/reference/core/index.md
Normal file
7
packages/docs/src/reference/core/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/core
|
||||||
|
|
||||||
|
<!--@include: ../../../../core/README.md{13,}-->
|
||||||
|
|
@ -6,23 +6,6 @@ outline: deep
|
||||||
|
|
||||||
These packages are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`.
|
These packages are different modules of ProzillaOS that can be installed separately or via the bundle package `prozilla-os`.
|
||||||
|
|
||||||
## Main
|
### Libraries
|
||||||
|
|
||||||
- [`prozilla-os`](https://www.npmjs.com/package/prozilla-os): A bundle containing `@prozilla-os/core` and all standard applications
|
<!--@include: ../../../README.md{4,23}-->
|
||||||
- [`@prozilla-os/core`](https://www.npmjs.com/package/@prozilla-os/core): Core functionality, React components and hooks
|
|
||||||
- [`@prozilla-os/skins`](https://www.npmjs.com/package/@prozilla-os/skins): Customizable skins for ProzillaOS
|
|
||||||
- [`@prozilla-os/shared`](https://www.npmjs.com/package/@prozilla-os/shared): Shared functions and utilities
|
|
||||||
|
|
||||||
## Standard applications
|
|
||||||
|
|
||||||
- [`@prozilla-os/file-explorer`](https://www.npmjs.com/package/@prozilla-os/file-explorer): File explorer app
|
|
||||||
- [`@prozilla-os/terminal`](https://www.npmjs.com/package/@prozilla-os/terminal): Terminal/shell app
|
|
||||||
- [`@prozilla-os/text-editor`](https://www.npmjs.com/package/@prozilla-os/text-editor): Text editor app
|
|
||||||
- [`@prozilla-os/settings`](https://www.npmjs.com/package/@prozilla-os/settings): Settings app
|
|
||||||
- [`@prozilla-os/media-viewer`](https://www.npmjs.com/package/@prozilla-os/media-viewer): Media viewer app
|
|
||||||
- [`@prozilla-os/browser`](https://www.npmjs.com/package/@prozilla-os/browser): Browser app
|
|
||||||
- [`@prozilla-os/calculator`](https://www.npmjs.com/package/@prozilla-os/calculator): Calculator app
|
|
||||||
|
|
||||||
## Non-standard applications
|
|
||||||
|
|
||||||
- [`@prozilla-os/logic-sim`](https://www.npmjs.com/package/@prozilla-os/logic-sim): Digital logic simulator app
|
|
||||||
|
|
|
||||||
7
packages/docs/src/reference/prozilla-os/index.md
Normal file
7
packages/docs/src/reference/prozilla-os/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# prozilla-os
|
||||||
|
|
||||||
|
<!--@include: ../../../../prozilla-os/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/shared/index.md
Normal file
7
packages/docs/src/reference/shared/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/shared
|
||||||
|
|
||||||
|
<!--@include: ../../../../shared/README.md{13,}-->
|
||||||
7
packages/docs/src/reference/skins/index.md
Normal file
7
packages/docs/src/reference/skins/index.md
Normal file
|
|
@ -0,0 +1,7 @@
|
||||||
|
---
|
||||||
|
outline: deep
|
||||||
|
---
|
||||||
|
|
||||||
|
# @prozilla-os/skins
|
||||||
|
|
||||||
|
<!--@include: ../../../../skins/README.md{13,}-->
|
||||||
|
|
@ -15,7 +15,7 @@
|
||||||
|
|
||||||
`prozilla-os` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla. This package combines multiple other packages for easy access to different ProzillaOS features. You can also download these packages separately instead.
|
`prozilla-os` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla. This package combines multiple other packages for easy access to different ProzillaOS features. You can also download these packages separately instead.
|
||||||
|
|
||||||
**Live demo: [os.prozilla.dev][website]** - [(source)][website-source]
|
**Live demo: [os.prozilla.dev][demo]** - [(source)][website-source]
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
|
@ -61,15 +61,43 @@ function App() {
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
|
||||||
### `<ProzillaOS>` props
|
### Configuration
|
||||||
|
|
||||||
```tsx
|
```tsx
|
||||||
{
|
interface ProzillaOSProps {
|
||||||
|
|
||||||
systemName: string,
|
systemName: string,
|
||||||
|
|
||||||
tagLine: string,
|
tagLine: string,
|
||||||
|
|
||||||
|
skin: new Skin({
|
||||||
|
|
||||||
|
appIcons: Record<number, string> | undefined,
|
||||||
|
|
||||||
|
appNames: Record<number, string> | undefined,
|
||||||
|
|
||||||
|
wallpapers: string[],
|
||||||
|
|
||||||
|
defaultWallpaper: string,
|
||||||
|
|
||||||
|
fileIcons: {
|
||||||
|
generic: string;
|
||||||
|
info: string | undefined;
|
||||||
|
text: string | undefined;
|
||||||
|
code: string | undefined;
|
||||||
|
},
|
||||||
|
|
||||||
|
folderIcons: {
|
||||||
|
generic: string;
|
||||||
|
images: string | undefined;
|
||||||
|
text: string | undefined;
|
||||||
|
link: string | undefined;
|
||||||
|
},
|
||||||
|
|
||||||
|
loadStyleSheet: () => void | undefined
|
||||||
|
|
||||||
|
})
|
||||||
|
|
||||||
config: {
|
config: {
|
||||||
apps: new AppsConfig({
|
apps: new AppsConfig({
|
||||||
|
|
||||||
|
|
@ -78,12 +106,6 @@ function App() {
|
||||||
}),
|
}),
|
||||||
desktop: new DesktopConfig({
|
desktop: new DesktopConfig({
|
||||||
|
|
||||||
/** Array of URLs of wallpaper images */
|
|
||||||
wallpapers: string[],
|
|
||||||
|
|
||||||
/** URL of default wallpaper image */
|
|
||||||
defaultWallpaper: string,
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @default 1
|
* @default 1
|
||||||
*/
|
*/
|
||||||
|
|
@ -96,6 +118,14 @@ function App() {
|
||||||
defaultIconDirection: 0 | 1
|
defaultIconDirection: 0 | 1
|
||||||
|
|
||||||
}),
|
}),
|
||||||
|
misc: new MiscConfig({
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @default 250
|
||||||
|
*/
|
||||||
|
doubleClickDelay: number
|
||||||
|
|
||||||
|
})
|
||||||
modals: new ModalsConfig({
|
modals: new ModalsConfig({
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
@ -131,19 +161,6 @@ function App() {
|
||||||
/** Google Analytics measurement ID */
|
/** Google Analytics measurement ID */
|
||||||
GAMeasurementId: string
|
GAMeasurementId: string
|
||||||
|
|
||||||
}),
|
|
||||||
virtualDrive: new VirtualDriveConfig({
|
|
||||||
|
|
||||||
fileIcon: string,
|
|
||||||
infoFileIcon: string,
|
|
||||||
textFileIcon: string,
|
|
||||||
codeFileIcon: string,
|
|
||||||
|
|
||||||
folderIcon: string,
|
|
||||||
imagesFolderIcon: string,
|
|
||||||
textFolderIcon: string,
|
|
||||||
folderLinkIcon: string
|
|
||||||
|
|
||||||
}),
|
}),
|
||||||
windows: new WindowsConfig({
|
windows: new WindowsConfig({
|
||||||
|
|
||||||
|
|
@ -171,13 +188,15 @@ function App() {
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/
|
[demo]: https://os.prozilla.dev/
|
||||||
|
[docs]: [docs]: https://os.prozilla.dev/docs/reference/prozilla-os
|
||||||
[website-source]: https://github.com/prozilla-os/ProzillaOS
|
[website-source]: https://github.com/prozilla-os/ProzillaOS
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/prozilla-os
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/prozilla-os
|
||||||
[npm]: https://www.npmjs.com/package/prozilla-os
|
[npm]: https://www.npmjs.com/package/prozilla-os
|
||||||
|
|
|
||||||
|
|
@ -48,13 +48,15 @@ export default defineConfig({
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/
|
[demo]: https://os.prozilla.dev/
|
||||||
|
[docs]: [docs]: https://os.prozilla.dev/docs/reference/shared
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/shared
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/shared
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/shared
|
[npm]: https://www.npmjs.com/package/@prozilla-os/shared
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
|
|
@ -25,13 +25,15 @@ $ pnpm add @prozilla-os/skins
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Website/demo][website]
|
- [Demo][demo]
|
||||||
|
- [Docs][docs]
|
||||||
- [GitHub][github]
|
- [GitHub][github]
|
||||||
- [npm][npm]
|
- [npm][npm]
|
||||||
- [Discord][discord]
|
- [Discord][discord]
|
||||||
- [Ko-fi][ko-fi]
|
- [Ko-fi][ko-fi]
|
||||||
|
|
||||||
[website]: https://os.prozilla.dev/
|
[demo]: https://os.prozilla.dev/
|
||||||
|
[docs]: https://os.prozilla.dev/docs/reference/skins
|
||||||
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/skins
|
[github]: https://github.com/prozilla-os/ProzillaOS/tree/main/packages/skins
|
||||||
[npm]: https://www.npmjs.com/package/@prozilla-os/skins
|
[npm]: https://www.npmjs.com/package/@prozilla-os/skins
|
||||||
[discord]: https://discord.gg/JwbyQP4tdz
|
[discord]: https://discord.gg/JwbyQP4tdz
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue