Skip to content

Commit f7e1c58

Browse files
olamilekan000olamilekan000
committed
add documentation to repo
Signed-off-by: olalekan odukoya <[email protected]>
1 parent cabe5de commit f7e1c58

Some content is hidden

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

56 files changed

+4544
-0
lines changed

‎go.sum‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
github.com/coreos/go-semver v0.3.1 h1:yi21YpKnrx1gt5R+la8n5WgS0kCrsPp33dmEyHReZr4=
22
github.com/coreos/go-semver v0.3.1/go.mod h1:irMmmIw/7yzSRPWryHsK7EYSg09caPQL03VsM8rvUec=
3+
github.com/cpuguy83/go-md2man/v2 v2.0.6 h1:XJtiaUW6dEEqVuZiMTn1ldk455QWwEIsMIJlo5vtkx0=
34
github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
45
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
56
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
@@ -23,6 +24,7 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb
2324
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
2425
github.com/rjeczalik/notify v0.9.3 h1:6rJAzHTGKXGj76sbRgDiDcYj/HniypXmSJo1SWakZeY=
2526
github.com/rjeczalik/notify v0.9.3/go.mod h1:gF3zSOrafR9DQEWSE8TjfI9NkooDxbyT4UgRGKZA0lc=
27+
github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
2628
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
2729
github.com/sevlyar/go-daemon v0.1.6 h1:EUh1MDjEM4BI109Jign0EaknA2izkOyi0LV3ro3QQGs=
2830
github.com/sevlyar/go-daemon v0.1.6/go.mod h1:6dJpPatBT9eUwM5VCw9Bt6CdX9Tk6UWvhW3MebLDRKE=

‎website/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/public
2+
resources/
3+
node_modules/
4+
.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/Makefile‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# SPDX-FileCopyrightText: Copyright The Colima Authors
2+
# SPDX-License-Identifier: Apache-2.0
3+
# See also: package.json
4+
NPM ?= npm
5+
6+
build serve: _output/docsy node_modules/.bin/hugo
7+
$(NPM) run $@
8+
9+
_output/docsy:
10+
$(MAKE) -C .. docsy
11+
12+
node_modules/.bin/hugo:
13+
$(NPM) install
14+
15+
clean:
16+
$(NPM) run $@
17+
rm -Rf _output

‎website/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# The source of the Colima website (https://colima.run)
2+
3+
This directory is the [Netlify base directory](https://docs.netlify.com/configure-builds/overview/) of [https://colima.run](https://colima.run/) .

‎website/assets/icons/colima.svg‎

Lines changed: 82 additions & 0 deletions
Loading

‎website/assets/scss/_variables_project.scss‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
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+
}
36+
37+
.td-search__input {
38+
color: var(--bs-body-color) !important;
39+
border: 1px solid var(--bs-gray-400) !important;
40+
}
41+
42+
.td-search__input:focus {
43+
color: inherit !important;
44+
border-color: var(--bs-body-bg) !important;
45+
box-shadow: 0 0 0 2px var(--bs-primary) !important;
46+
}
47+
48+
.td-search__input::placeholder {
49+
color: var(--bs-gray) !important;
50+
}
51+
52+
.td-search__icon {
53+
color: $secondary !important;
54+
}

‎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: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
+++
2+
title = "Colima"
3+
linkTitle = "Colima"
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 Colima?</strong>
18+
</p>
19+
20+
<p>
21+
Colima provides container runtimes on macOS (and Linux) with minimal setup. Docker, containerd, and Kubernetes on macOS with a simple CLI.
22+
</p>
23+
{{% /blocks/lead %}}
24+
{{< blocks/section color="dark" type="row" >}}
25+
26+
{{< blocks/helpfullinks >}}
27+
28+
{{< /blocks/section >}}
29+
30+
{{< blocks/cncf >}}

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: "Colima: Container Runtimes on macOS"
3+
linkTitle: Documentation
4+
menu: {main: {weight: 20}}
5+
weight: 20
6+
---
7+
{{% fixlinks %}}
8+
Colima provides container runtimes on macOS (and Linux) with minimal setup.
9+
10+
✅ Simple CLI to start/stop container runtime
11+
12+
✅ Built-in support for [Docker](https://www.docker.com) (default)
13+
14+
✅ Support for [containerd](https://containerd.io) and [Kubernetes](https://kubernetes.io)
15+
16+
✅ Automatic file sharing
17+
18+
✅ Automatic port forwarding
19+
20+
✅ Intel on Intel
21+
22+
✅ ARM on ARM
23+
24+
✅ Various guest Linux distributions: [AlmaLinux](./templates/almalinux.yaml), [Alpine](./templates/alpine.yaml), [Arch Linux](./templates/archlinux.yaml), [Debian](./templates/debian.yaml), [Fedora](./templates/fedora.yaml), [openSUSE](./templates/opensuse.yaml), [Oracle Linux](./templates/oraclelinux.yaml), [Rocky](./templates/rocky.yaml), [Ubuntu](./templates/ubuntu.yaml) (default), ...
25+
26+
Related project: [sshocker (ssh with file sharing and port forwarding)](https://github.com/lima-vm/sshocker)
27+
28+
This project is unrelated to [The Lima driver project (driver for ARM Mali GPUs)](https://gitlab.freedesktop.org/lima).
29+
30+
## Motivation
31+
32+
Colima was created to provide a simple and easy-to-use alternative for running Docker Desktop on macOS.
33+
It leverages [Lima](https://github.com/lima-vm/lima) to provide Linux virtual machines with automatic file sharing and port forwarding.
34+
The goal is to provide Docker (and Kubernetes) on macOS with minimal setup, while also supporting containerd and other container runtimes.
35+
{{% /fixlinks %}}

0 commit comments

Comments
 (0)