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
|
`GSP` (pronounced _gee ess pee_) is a transpiler to convert a nicer to write and
more human-friendly syntax into valid HTML. Writing HTML can be made more
bearable using things like Emmet, but it’s still not great, and the syntax is
far too bloated, visually polluting your documents.
`GSP` will never support templating or other useless features. If you need
support for such things, just use a programming- or macro language such as
Python or M4.
## Installation
You need to ensure you have both the Go compiler and the `make` command
available. If you don’t have Go, you can get it [here][1]. If you’re on a
UNIX-like system such as Linux or MacOS then you should already have `make`. If
you’re on Windows you should be using WSL anyways, and you can figure out how to
get Make. You also need Git.
First, clone the repository and move into it:
```
$ git clone https://git.sr.ht/~mango/gsp
$ cd gsp
```
Then you can compile the transpiler with either of the two commands:
```
$ make
$ go build
```
Finally, you can install the transpiler and documentation with the following:
```
$ sudo make install
```
## Documentation
Documentation for the transpiler can be found in the `gsp(1)` manual and
documentation for the language can be found in the `gsp(5)` manual:
```
$ man gsp # transpiler documentation
$ man 5 gsp # language documentation
```
## Why Not Use Pug or [INSERT LANGUAGE HERE]
Simply put, they are all trash. Pug has decent syntax but requires you use
JavaScript. All the others fall for the same kind of problem. As far as I
could find, there is no pre-GSP transpiler from good syntax to HTML that works
as just one binary you call on some files. All options force you into needing
to write JavaScript/Ruby/etc. scripts, which just isn’t good enough.
## Syntax Example
```gsp
html lang="en" {
head {
meta charset="UTF-8" {}
meta name="viewport" content="width=device-width, initial-scale=1.0" {}
link href="/favicon.svg" rel="shortcut icon" type="image/svg" {}
link href="/style.svg" rel="stylesheet" {}
title {-My Website Title}
}
body {
p #my-id {- This is a paragraph with the id ‘my-id’ }
p .my-cls {- This is a paragraph with the class ‘my-cls’ }
p
#some-id
.class-1
.class-2
key-1="value-1"
key-2 = "value-2"
{-
This paragraph has an ID, two classes, and two additional attributes. GSP
allows us to use the ‘#ident’ and ‘.ident’ syntaxes as shorthands for
applying IDs, and classes. This is a text node, so nothing is being
interpreted as GSP nodes, but we can include them inline if we want. As
an example, here is some @em {-emphatic} text. Your inline nodes can also
have attributes @em #id .cls {-just like a regular node}.
}
}
}
```
## Why The Name GSP?
I was originally inspired by Pug, but my dog is a GSP, not a pug.
[1]: https://go.dev/dl/
|
