summaryrefslogtreecommitdiff
path: root/content/posts/shadesofblue/240317-gettingstarted.md
blob: 66c5176fb373aaafe3279c300e9e6c1c8ed4070d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
+++
title = 'Getting started'
publishdate = 2024-03-17
summary = "Paolo, Petja, Stefan und Tom haben in Doccione Tag und Nacht an den neuen Stücken gearbeitet. Wir sind total happy, dass wir in einer Woche auch noch “Night in Tunisia“ hinbekommen haben. Es fehlt noch eine Schlagzeugerin!"
image = "/img/doccione1.jpg"
caption = "Doccione in Italien"
bands = ['ShadesOfBlue']
+++

![schiffe](/img/schiffe.jpg "Schiffe in Italien")

{{< video 
    src="/video/flug.mov"
    caption="Flugzeug"
>}}

{{< audio 
    src="/audio/LandUnter.m4a" 
    caption="ShadesOfBlue, Land Unter"
>}}

{{< audio 
    src="/audio/ComesLove.m4a" 
    caption="ShadesOfBlue, Comes Love"
>}}

### From Source
With the Rust toolchain installed, you can install Blades from [crates.io](https://crates.io/crates/blades)
```sh
cargo install blades
```

Or from its repository
``` sh
git clone https://github.com/grego/blades
cd blades
cargo install --path .
```

### macOS

Using the package manager [MacPorts](https://www.macports.org)
```sh
sudo port install blades
```

## Blades Commands
Once installed, you can run the executable `blades` with the following subcommands:
<div id="commands">

`init` Initialise the site in the current directory, creating the basic files and folders

`build` Build the site according to config, content, templates and themes in the current directory

`colocate` Move the assets from the "assets" directory and from the theme, if one is used, into the output directory

`all` Build the site and colocate the assets

`lazy` Build the site and (colocate assets only if the theme was switched) [default]

`new` Create a new page

</div>

## Themes
When you specify a theme in the [config](config.html), templates and assets from the theme are used.
Every site that doesn't use a theme can be used as a theme for another site.
To use it, simply clone it into the themes directory.
```sh
cd themes
git clone $site_repository
```

Then, set it as a theme in `Blades.toml`:
```toml
theme = "$site_name"
```

To overwrite the theme, simply use the files in the `templates`, resp. `assets` subdirectories of the
page root directory.

## Assets
All the files from the `assets` directory (and from the theme) are moved into the directory
specified in the [config](config.html), which is emptied before. This is a subdirectory of the
output directory (defaults to `assets`).

Blades takes of the pages it rendered before and if some of them is deleted, the corresponding
files in the output directory will be deleted, too. The other files in the output directory
are left intact. This way, you can place anything in the output directory and (as long as its name
differs from all the page names and it's not in the assets subdirectory), Blades won't touch it.

## Meta
Blades renders [sitemap](https://www.sitemaps.org) (into `sitemap.xml`), [Atom](https://en.wikipedia.org/wiki/Atom_(Web_standard)) (into `atom.xml`)
and [RSS](https://en.wikipedia.org/wiki/RSS) (into `rss.xml`) feeds, unless explicitly disabled in the [config](config.html).

## Contribution
If you found a bug or would like to see some feature in Blades, you are the most welcome to submit an issue
or a pull request! Likewise if you found something in this documentation not clear or imprecise.
"""