Skip to content

Commit

Permalink
Add a home page
Browse files Browse the repository at this point in the history
  • Loading branch information
pepicrft committed Dec 24, 2024
1 parent 55fb529 commit 4771f8d
Show file tree
Hide file tree
Showing 12 changed files with 89 additions and 191 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Alternatively, you can [download the binary from the releases page](https://gith

## Documentation

The documentation is available at [https://virtualos.tuist.io](https://virtualos.tuist.io).
The documentation is available at [https://virtualos.tuist.dev](https://virtualos.tuist.dev).
87 changes: 59 additions & 28 deletions docs/.vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -1,54 +1,85 @@
import { defineConfig } from 'vitepress'
import {atom01Icon} from "./icons.mjs";
import { defineConfig } from "vitepress";
import { atom01Icon } from "./icons.mjs";

// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "virtualOS",
titleTemplate: ":title | virtualOS",
srcDir: "content",
lastUpdated: true,
description: "A virtualization CLI for macOS environments",
cleanUrls: true,
sitemap: {
hostname: "https://virtualos.tuist.io",
hostname: "https://virtualos.tuist.dev",
},
head: [
[
"script",
{},
`
!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||[]);
posthog.init('phc_EnaSStQDtLbwAfHCaqpFtwMPPq6mNRjuw8dZbtpFNoH',{api_host:'https://eu.i.posthog.com'})
`,
"meta",
{ property: "og:url", content: "https://virtualos.tuist.dev" },
"",
],
["meta", { property: "og:type", content: "website" }, ""],
[
"script",
{},
`
!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)}();
`,
"meta",
{ property: "og:image", content: "https://virtualos.tuist.dev/og.jpeg" },
"",
],
["meta", { name: "twitter:card", content: "summary" }, ""],
[
"meta",
{ property: "twitter:domain", content: "virtualos.tuist.dev" },
"",
],
[
"meta",
{ property: "twitter:url", content: "https://virtualos.tuist.dev" },
"",
],
[
"meta",
{
name: "twitter:image",
content: "https://virtualos.tuist.dev/og.jpeg",
},
"",
],
],
themeConfig: {
logo: "/logo.png",
editLink: {
pattern: 'https://github.com/tuist/virtualos/edit/main/docs/:path'
pattern: "https://github.com/tuist/virtualos/edit/main/docs/:path",
},
nav: [
{ text: 'Tuist', link: 'https://tuist.io' },
{ text: 'Slack', link: 'https://slack.tuist.io' }
{ text: "Tuist", link: "https://tuist.dev" },
{ text: "Community", link: "https://community.tuist.dev" },
{ text: "Slack", link: "https://slack.tuist.dev" },
],
search: {
provider: "local",
},
sidebar: [
{
text: `<div style="display: flex; flex-direction: row; align-items: center; gap: 7px;">Examples ${atom01Icon()}</div>`,
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
text: `<div style="display: flex; flex-direction: row; align-items: center; gap: 7px;">virtualOS ${atom01Icon()}</div>`,
link: "/",
items: [{ text: "Markdown Examples", link: "/markdown-examples" }],
},
],

editLink: {
pattern:
"https://github.com/tuist/virtualos/edit/main/docs/content/:path",
},
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
}
})
{ icon: "github", link: "https://github.com/tuist/tuist" },
{ icon: "bluesky", link: "https://bsky.app/profile/tuist.dev" },
{ icon: "mastodon", link: "https://fosstodon.org/@tuist" },
{
icon: "slack",
link: "https://join.slack.com/t/tuistapp/shared_invite/zt-1y667mjbk-s2LTRX1YByb9EIITjdLcLw",
},
],
footer: {
message: "Released under the MIT License.",
copyright: "Copyright © 2024-present Tuist GmbH",
},
},
});
49 changes: 0 additions & 49 deletions docs/api-examples.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/content/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "virtualOS - Virtualized macOS environments"
titleTemplate: :title
---

# virtualOS

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.
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.

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.

## Installation

You can install virtualOS using [Mise](https://mise.jdx.dev/):

```bash
mise install virtualos
mise use -g virtualos@latest # To activate it globally
```

Alternatively, you can [download the binary from the releases page](https://github.com/tuist/virtualOS/releases).

> [!WARNING] WORK IN PROGRESS
> 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.
Binary file added docs/content/public/favicon.ico
Binary file not shown.
Binary file added docs/content/public/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/public/og.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 0 additions & 25 deletions docs/index.md

This file was deleted.

85 changes: 0 additions & 85 deletions docs/markdown-examples.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"devDependencies": {
"vitepress": "^1.3.0",
"vitepress": "^1.5.0",
"wrangler": "^3.28.2"
},
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion docs/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion renovate.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
":semanticCommits",
":disableDependencyDashboard",
"config:recommended"
],
"packageRules": [
{
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
"labels": ["changelog:updated-dependencies"],
"automerge": true,
"automergeType": "pr",
"automergeStrategy": "auto"
Expand Down

0 comments on commit 4771f8d

Please sign in to comment.