Skip to content

Commit cd4894f

Browse files
committed
Basic usage info
1 parent 8e7e666 commit cd4894f

File tree

9 files changed

+50
-43
lines changed

9 files changed

+50
-43
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 Leo Mickelson
3+
Copyright (c) 2024 Multiple Tool Version Manager
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

content/_index.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: My Site
2+
title: MTVM - Multiple Tool Version Manager
33
toc: false
44
---
55

@@ -9,9 +9,5 @@ This is the landing page.
99

1010
{{< cards >}}
1111
{{< card link="docs" title="Docs" icon="book-open" >}}
12-
{{< card link="about" title="About" icon="user" >}}
12+
{{< card link="about" title="About" icon="information-circle" >}}
1313
{{< /cards >}}
14-
15-
## Documentation
16-
17-
For more information, visit [Hextra](https://imfing.github.io/hextra).

content/docs/_index.md

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
11
---
22
title: Documentation
3-
next: first-page
3+
type: docs
4+
prev: /
5+
next: docs/gettingstarted/
46
---
57

6-
This is a demo of the theme's documentation layout.
7-
8-
## Hello, World!
9-
10-
```go {filename="main.go"}
11-
package main
12-
13-
import "fmt"
14-
15-
func main() {
16-
fmt.Println("Hello, World!")
17-
}
18-
```
8+
## Welcome to the MTVM Documentation!
9+
You can click the next button to proceed, and the back button to go back.

content/docs/first-page.md

Lines changed: 0 additions & 9 deletions
This file was deleted.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Getting started
3+
type: docs
4+
prev: docs/
5+
next: installation
6+
---
7+
This section contains information on how to get up and running with MTVM!
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Installation
3+
type: docs
4+
prev: docs/getting-started/
5+
next: usage
6+
---
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Usage
3+
type: docs
4+
prev: installation
5+
---
6+
## Installing a version of a tool
7+
The only pre-installed plugin is go because go is needed to compile plugins you download. You might not have go installed but you can install it using MTVM of course!
8+
You can download go using this command:
9+
```
10+
mtvm install go latest
11+
```
12+
Then set it as the current go version using this command:
13+
```
14+
mtvm use go latest
15+
```
16+
But you can also install versions directly from the use command using the \--install flag, like this:
17+
```
18+
mtvm use go latest --install
19+
```
20+
If you want to install a specific version, just replace latest with the version number. Latest is special because it retrieves the version number of the latest version of the tool, so you don't have to look for the newest version yourself!

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/imfing/hextra-starter-template
1+
module mtvm/docs
22

33
go 1.21
44

hugo.yaml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Hugo configuration file
2-
title: My Site
2+
title: MTVM
33

44
# import hextra as module
55
module:
@@ -24,23 +24,15 @@ menu:
2424
- name: About
2525
pageRef: /about
2626
weight: 2
27-
- name: Contact ↗
28-
url: "https://github.com/imfing"
29-
weight: 3
3027
- name: Search
3128
weight: 4
3229
params:
3330
type: search
3431
- name: GitHub
3532
weight: 5
36-
url: "https://github.com/imfing/hextra-starter-template"
33+
url: "https://github.com/MTVersionManager/mtvm"
3734
params:
3835
icon: github
39-
- name: Twitter
40-
weight: 6
41-
url: "https://twitter.com/"
42-
params:
43-
icon: x-twitter
4436

4537
params:
4638
navbar:
@@ -52,5 +44,9 @@ params:
5244
displayPoweredBy: true
5345

5446
editURL:
55-
enable: true
56-
base: "https://github.com/imfing/hextra-starter-template/edit/main/content"
47+
enable: false
48+
49+
theme:
50+
# light | dark | system
51+
default: system
52+
displayToggle: true

0 commit comments

Comments
 (0)