blob: ecd8d0ad872befb974c48503f9517e1671841d56 (
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
|
---
title: Crocc
description: Crocc is a simple and fast static-site generator based on Markdown.
keywords:
- crocc
- markdown
- html
- go
- golang
- static
- site
- generator
- ssg
- website
- simple
publication_time: 2023-04-26T19:05:00Z
publication_time: 2023-04-27T00:08:00Z
author: Nicolas Paul <n@nc0.fr>
---
# Crocc
Crocc is a simple static-site generator based on Markdown.
The main goal of Crocc is to offer simplicity, as opposed to other static-site
generation tools such as Hugo or Jekyll.
Indeed, you only need Markdown to write content in a productive manner, and
everything else is standard scripts (JavaScript, CSS, images, etc.).
## Installation
To install Crocc from sources, you need to have Go installed on your system.
Then, run the following command:
```bash
$ go install go.nc0.fr/crocc@latest
```
> Note: You can replace `latest` with a specific Git commit.
## Usage
See the [example](/example) for a simple example of a Crocc website.
A more concrete project is
[this website itself](https://github.com/n1c00o/crocc/tree/master/doc), which
is built with Crocc.
## Documentation
See the [documentation](/doc) for more information.
## License
The project is governed by a BSD-style license that can be found in the
[LICENSE](https://github.com/n1c00o/crocc/blob/master/LICENSE) file.
The banner image is a [photo](https://unsplash.com/photos/R3sgrDvXz3I) from
[Unsplash](https://unsplash.com/) by
[Thomas Couillard](https://unsplash.com/@thomascouillard).
Favicons are Noto emojis and are licensed under the
[Apache License 2.0](https://github.com/googlefonts/noto-emoji/blob/main/LICENSE)
license.
|
