Skip to content
This repository was archived by the owner on Feb 14, 2025. It is now read-only.

Commit 4771f8d

Browse files
committed
Add a home page
1 parent 55fb529 commit 4771f8d

12 files changed

+89
-191
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Alternatively, you can [download the binary from the releases page](https://gith
3131

3232
## Documentation
3333

34-
The documentation is available at [https://virtualos.tuist.io](https://virtualos.tuist.io).
34+
The documentation is available at [https://virtualos.tuist.dev](https://virtualos.tuist.dev).

docs/.vitepress/config.mjs

+59-28
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,85 @@
1-
import { defineConfig } from 'vitepress'
2-
import {atom01Icon} from "./icons.mjs";
1+
import { defineConfig } from "vitepress";
2+
import { atom01Icon } from "./icons.mjs";
33

44
// https://vitepress.dev/reference/site-config
55
export default defineConfig({
66
title: "virtualOS",
77
titleTemplate: ":title | virtualOS",
8+
srcDir: "content",
9+
lastUpdated: true,
810
description: "A virtualization CLI for macOS environments",
11+
cleanUrls: true,
912
sitemap: {
10-
hostname: "https://virtualos.tuist.io",
13+
hostname: "https://virtualos.tuist.dev",
1114
},
1215
head: [
1316
[
14-
"script",
15-
{},
16-
`
17-
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host.replace(".i.posthog.com","-assets.i.posthog.com")+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getFeatureFlag getFeatureFlagPayload reloadFeatureFlags group updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures getActiveMatchingSurveys getSurveys onSessionId".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
18-
posthog.init('phc_EnaSStQDtLbwAfHCaqpFtwMPPq6mNRjuw8dZbtpFNoH',{api_host:'https://eu.i.posthog.com'})
19-
`,
17+
"meta",
18+
{ property: "og:url", content: "https://virtualos.tuist.dev" },
19+
"",
2020
],
21+
["meta", { property: "og:type", content: "website" }, ""],
2122
[
22-
"script",
23-
{},
24-
`
25-
!function(t){if(window.ko)return;window.ko=[],["identify","track","removeListeners","open","on","off","qualify","ready"].forEach(function(t){ko[t]=function(){var n=[].slice.call(arguments);return n.unshift(t),ko.push(n),ko}});var n=document.createElement("script");n.async=!0,n.setAttribute("src","https://cdn.getkoala.com/v1/pk_3f80a3529ec2914b714a3f740d10b12642b9/sdk.js"),(document.body || document.head).appendChild(n)}();
26-
`,
23+
"meta",
24+
{ property: "og:image", content: "https://virtualos.tuist.dev/og.jpeg" },
25+
"",
26+
],
27+
["meta", { name: "twitter:card", content: "summary" }, ""],
28+
[
29+
"meta",
30+
{ property: "twitter:domain", content: "virtualos.tuist.dev" },
31+
"",
32+
],
33+
[
34+
"meta",
35+
{ property: "twitter:url", content: "https://virtualos.tuist.dev" },
36+
"",
37+
],
38+
[
39+
"meta",
40+
{
41+
name: "twitter:image",
42+
content: "https://virtualos.tuist.dev/og.jpeg",
43+
},
44+
"",
2745
],
2846
],
2947
themeConfig: {
48+
logo: "/logo.png",
3049
editLink: {
31-
pattern: 'https://github.com/tuist/virtualos/edit/main/docs/:path'
50+
pattern: "https://github.com/tuist/virtualos/edit/main/docs/:path",
3251
},
3352
nav: [
34-
{ text: 'Tuist', link: 'https://tuist.io' },
35-
{ text: 'Slack', link: 'https://slack.tuist.io' }
53+
{ text: "Tuist", link: "https://tuist.dev" },
54+
{ text: "Community", link: "https://community.tuist.dev" },
55+
{ text: "Slack", link: "https://slack.tuist.dev" },
3656
],
3757
search: {
3858
provider: "local",
3959
},
4060
sidebar: [
4161
{
42-
text: `<div style="display: flex; flex-direction: row; align-items: center; gap: 7px;">Examples ${atom01Icon()}</div>`,
43-
items: [
44-
{ text: 'Markdown Examples', link: '/markdown-examples' },
45-
{ text: 'Runtime API Examples', link: '/api-examples' }
46-
]
47-
}
62+
text: `<div style="display: flex; flex-direction: row; align-items: center; gap: 7px;">virtualOS ${atom01Icon()}</div>`,
63+
link: "/",
64+
items: [{ text: "Markdown Examples", link: "/markdown-examples" }],
65+
},
4866
],
49-
67+
editLink: {
68+
pattern:
69+
"https://github.com/tuist/virtualos/edit/main/docs/content/:path",
70+
},
5071
socialLinks: [
51-
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
52-
]
53-
}
54-
})
72+
{ icon: "github", link: "https://github.com/tuist/tuist" },
73+
{ icon: "bluesky", link: "https://bsky.app/profile/tuist.dev" },
74+
{ icon: "mastodon", link: "https://fosstodon.org/@tuist" },
75+
{
76+
icon: "slack",
77+
link: "https://join.slack.com/t/tuistapp/shared_invite/zt-1y667mjbk-s2LTRX1YByb9EIITjdLcLw",
78+
},
79+
],
80+
footer: {
81+
message: "Released under the MIT License.",
82+
copyright: "Copyright © 2024-present Tuist GmbH",
83+
},
84+
},
85+
});

docs/api-examples.md

-49
This file was deleted.

docs/content/index.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "virtualOS - Virtualized macOS environments"
3+
titleTemplate: :title
4+
---
5+
6+
# virtualOS
7+
8+
In November 2020, Apple introduced the [Virtualization framework](https://developer.apple.com/documentation/virtualization), which provides a high-level API for creating and managing virtual machines.
9+
This technology brought us closer to having a [Docker](https://www.docker.com/)-like experience for macOS, where we can run macOS environments in isolation, but lacked a user-friendly CLI-based interface to manage and run these virtual machines.
10+
11+
virtualOS is a CLI tool that aims to provide a user-friendly interface to manage and run virtual machines on macOS using the Virtualization framework. It aligns with the Docker CLI interface for familiarity, and embraces the OCI image format to define the virtual machine images.
12+
13+
## Installation
14+
15+
You can install virtualOS using [Mise](https://mise.jdx.dev/):
16+
17+
```bash
18+
mise install virtualos
19+
mise use -g virtualos@latest # To activate it globally
20+
```
21+
22+
Alternatively, you can [download the binary from the releases page](https://github.com/tuist/virtualOS/releases).
23+
24+
> [!WARNING] WORK IN PROGRESS
25+
> virtualOS is a work in progress. We are actively working on it, and we are looking for contributors to help us build it. If you are interested, you can grab one of the issues labeled as `good first issue` and start contributing.

docs/content/public/favicon.ico

5.43 KB
Binary file not shown.

docs/content/public/logo.png

1.06 MB
Loading

docs/content/public/og.jpeg

627 KB
Loading

docs/index.md

-25
This file was deleted.

docs/markdown-examples.md

-85
This file was deleted.

docs/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"devDependencies": {
3-
"vitepress": "^1.3.0",
3+
"vitepress": "^1.5.0",
44
"wrangler": "^3.28.2"
55
},
66
"scripts": {

docs/pnpm-lock.yaml

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

renovate.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
{
22
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
33
"extends": [
4+
":semanticCommits",
5+
":disableDependencyDashboard",
46
"config:recommended"
57
],
68
"packageRules": [
79
{
810
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
9-
"labels": ["changelog:updated-dependencies"],
1011
"automerge": true,
1112
"automergeType": "pr",
1213
"automergeStrategy": "auto"

0 commit comments

Comments
 (0)