Skip to content

Commit eeaf7ff

Browse files
balajiv113balajiv113
committed
Revamp lima website using docsy
Signed-off-by: Balaji Vijayakumar <[email protected]>
1 parent 938ea3e commit eeaf7ff

40 files changed

+1357
-285
lines changed

‎website/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/public
2+
resources/
3+
node_modules/
4+
package-lock.json
5+
.hugo_build.lock

‎website/.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lts/*

‎website/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
11
# The source of the Lima website (https://lima-vm.io)
22

3-
This directory is the [Netlify base directory](https://docs.netlify.com/configure-builds/overview/) of [https://lima-vm.io](https://lima-vm.io/) .
4-
5-
The actual contents are generated from the markdown files on the browser side:
6-
- [`../README.md`](../README.md)
7-
- [`../docs/*.md`](../docs/)
8-
- [`../examples/README.md`](../examples/README.md)
9-
10-
The site is previewable and deployable with just the single [`index.html`](./index.html).
11-
12-
No dependency on any templating engine currently, but eventually we may adopt docsy or something else similar.
3+
This directory is the [Netlify base directory](https://docs.netlify.com/configure-builds/overview/) of [https://lima-vm.io](https://lima-vm.io/) .

‎website/assets/icons/logo.svg

Lines changed: 10 additions & 0 deletions
Loading

‎website/assets/scss/_variables_project.scss

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/*
2+
3+
Add styles or override variables from the theme here.
4+
5+
*/
6+
7+
$display1-weight: 500 !default;
8+
$display2-weight: 100 !default;
9+
10+
$primary: rgb(255, 255, 255) !default;
11+
$secondary: rgb(66.274512%, 81.176472%, 21.960784%) !default;
12+
$dark: black !default;
13+
$td-sidebar-tree-root-color: #222 !default;
14+
15+
.nav-shadow {
16+
box-shadow: 0 2px 2px -2px rgba(0, 0, 0, .2);
17+
}
18+
19+
.nav-link {
20+
text-shadow: none !important;
21+
}
22+
23+
.cncf-logo {
24+
width: 20rem;
25+
max-width: 80%;
26+
}
27+
28+
.join-community {
29+
color: $dark !important;
30+
background: $secondary !important;
31+
32+
.td-arrow-down:before {
33+
border-color: $secondary transparent transparent transparent !important;
34+
}
35+
}

‎website/config.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# THIS IS A TEST CONFIG ONLY!
2+
# FOR THE CONFIGURATION OF YOUR SITE USE hugo.yaml.
3+
#
4+
# As of Docsy 0.7.0, Hugo 0.110.0 or later must be used.
5+
#
6+
# The sole purpose of this config file is to detect Hugo-module builds that use
7+
# an older version of Hugo.
8+
#
9+
# DO NOT add any config parameters to this file. You can safely delete this file
10+
# if your project is using the required Hugo version.
11+
12+
module:
13+
hugoVersion:
14+
extended: true
15+
min: 0.110.0

‎website/content/en/_index.html

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
+++
2+
title = "Lima"
3+
linkTitle = "Lima"
4+
5+
+++
6+
7+
{{< blocks/cover title="" image_anchor="top" height="min" color="white" >}}
8+
<div class="mx-auto">
9+
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="{{< relref "/docs" >}}">
10+
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
11+
</a>
12+
</div>
13+
{{< /blocks/cover >}}
14+
15+
{{% blocks/lead color="secondary" %}}
16+
<p>
17+
<strong>What is Lima?</strong>
18+
</p>
19+
20+
<p>
21+
Lima launches Linux virtual machines with automatic file sharing and port forwarding (similar to WSL2).
22+
</p>
23+
{{% /blocks/lead %}}
24+
{{< blocks/section color="dark" type="row" >}}
25+
{{% blocks/feature icon="fa-solid fa-code" title="Install Lima" %}}
26+
<a class="mr-3 mb-4 text-secondary" href="{{< relref "/docs/installation" >}}">
27+
Get Lima Here <i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
28+
{{% /blocks/feature %}}
29+
30+
{{% blocks/feature icon="fa-solid fa-chalkboard" title="Try Lima" %}}
31+
<a class="mr-3 mb-4 text-secondary" href="{{< relref "/docs/usage" >}}">
32+
Get started with Lima <i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
33+
{{% /blocks/feature %}}
34+
35+
{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome" %}}
36+
<a class="mr-3 mb-4 text-secondary" href="{{< relref "/community" >}}">
37+
Join the Lima community <i class="fas fa-arrow-alt-circle-right ml-2"></i></a>
38+
{{% /blocks/feature %}}
39+
40+
{{< /blocks/section >}}
41+
42+
{{< blocks/adoptors >}}
43+
44+
{{< blocks/cncf >}}

‎website/content/en/community/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Community
3+
menu: {main: {weight: 40}}
4+
---
5+
6+

‎website/content/en/docs/Examples/_index.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Examples
3+
weight: 3
4+
---
5+
## uname
6+
```console
7+
$ uname -a
8+
Darwin macbook.local 20.4.0 Darwin Kernel Version 20.4.0: Thu Apr 22 21:46:47 PDT 2021; root:xnu-7195.101.2~1/RELEASE_X86_64 x86_64
9+
10+
$ lima uname -a
11+
Linux lima-default 5.11.0-16-generic #17-Ubuntu SMP Wed Apr 14 20:12:43 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
12+
13+
$ LIMA_INSTANCE=arm lima uname -a
14+
Linux lima-arm 5.11.0-16-generic #17-Ubuntu SMP Wed Apr 14 20:10:16 UTC 2021 aarch64 aarch64 aarch64 GNU/Linux
15+
```
16+
{{% fixlinks %}}
17+
See [`./docs/multi-arch.md`](./docs/multi-arch.md) for Intel-on-ARM and ARM-on-Intel .
18+
{{% /fixlinks %}}
19+
## Sharing files across macOS and Linux
20+
```console
21+
$ echo "files under /Users on macOS filesystem are readable from Linux" > some-file
22+
23+
$ lima cat some-file
24+
files under /Users on macOS filesystem are readable from Linux
25+
26+
$ lima sh -c 'echo "/tmp/lima is writable from both macOS and Linux" > /tmp/lima/another-file'
27+
28+
$ cat /tmp/lima/another-file
29+
/tmp/lima is writable from both macOS and Linux
30+
```
31+
32+
## Running containerd containers (compatible with Docker containers)
33+
```console
34+
$ lima nerdctl run -d --name nginx -p 127.0.0.1:8080:80 nginx:alpine
35+
```
36+
37+
> You don't need to run "lima nerdctl" everytime, instead you can use special shortcut called "nerdctl.lima" to do the same thing. By default, it'll be installed along with the lima, so, you don't need to do anything extra. There will be a symlink called nerdctl pointing to nerdctl.lima. This is only created when there is no nerdctl entry in the directory already though. It worths to mention that this is created only via make install. Not included in Homebrew/MacPorts/nix packages.
38+
39+
<http://127.0.0.1:8080> is accessible from both macOS and Linux.
40+
41+
For the usage of containerd and nerdctl (contaiNERD ctl), visit <https://github.com/containerd/containerd> and <https://github.com/containerd/nerdctl>.

‎website/content/en/docs/Installation/_index.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Installation
3+
weight: 1
4+
---
5+
> **NOTE**
6+
> Lima is not regularly tested on ARM Mac (due to lack of CI).
7+
8+
## Package Manager
9+
10+
### Homebrew
11+
12+
Homebrew can be used to install lima on macOS and Linux.
13+
14+
```console
15+
brew install lima
16+
```
17+
18+
[Homebrew package](https://github.com/Homebrew/homebrew-core/blob/master/Formula/l/lima.rb) is available here.
19+
20+
## Manual installation
21+
22+
### Prerequisite
23+
24+
- QEMU 7.0 or later (Required, only if QEMU driver is used)
25+
26+
### Install Lima from binary
27+
Download the binary archive of Lima from <https://github.com/lima-vm/lima/releases>,
28+
and extract it under `/usr/local` (or somewhere else).
29+
30+
```bash
31+
brew install jq
32+
VERSION=$(curl -fsSL https://api.github.com/repos/lima-vm/lima/releases/latest | jq -r .tag_name)
33+
curl -fsSL "https://github.com/lima-vm/lima/releases/download/${VERSION}/lima-${VERSION:1}-$(uname -s)-$(uname -m).tar.gz" | tar Cxzvm /usr/local
34+
```
35+
36+
### Install Lima from source
37+
38+
To install Lima from the source, run `make && make install`.

0 commit comments

Comments
 (0)