README.md 2.2 KB
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1
2
# Site.js web site

Aral Balkan's avatar
Aral Balkan committed
3
Source code for [the Site.js web site](https://sitejs.org).
Aral Balkan's avatar
Aral Balkan committed
4

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
## Clone

> __⚠️ Do not clone this repository from GitHub.__
>
> The GitHub version is a mirror and _does not contain the Git LFS objects_. Feel free to report issues here, etc., but do not clone from here if you’re going to deploy the site.

1. Make sure you have [the Git LFS git extension](https://git-lfs.github.com/) installed (e.g., for Ubuntu):

    ```shell
    sudo apt install git-lfs
    git lfs install
    ```

2. Clone the repository via the links on the canonical repository at https://source.small-tech.org/site.js/site 

Aral Balkan's avatar
Aral Balkan committed
20
21
22
## Install

```sh
23
./install
Aral Balkan's avatar
Aral Balkan committed
24
25
26
27
28
29
30
31
```

## Build

```sh
./build
```

Aral Balkan's avatar
Aral Balkan committed
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
The following features require [Site.js](https://sitejs.org):

## Test locally

Test the source:

```sh
site
```

Test the distribution build:

```sh
site dist
```

## Stage

Stage the source:

```sh
site @hostname
```

Stage the distribution build:

```
site dist @hostname
```

Aral Balkan's avatar
Aral Balkan committed
62
63
64
65
66
67
68
69
## Deploy

If you have SSH access to the Site.js web site:

```sh
./deploy
```

70
71
__Note:__ The scripts use the latest Site.js syntax.

Aral Balkan's avatar
Aral Balkan committed
72
73
## Useful components

Aral Balkan's avatar
Aral Balkan committed
74
You might find these components useful in your own projects:
Aral Balkan's avatar
Aral Balkan committed
75
76
77
78
79

  * [Inline CSS and JS](_build/inline-css-and-js.js): script that inlines CSS and JS into the HTML during the build process.

  * [Inline SVG](_build/inline-svg.js): script that inlines SVG into the HTML during the build process.

Aral Balkan's avatar
Aral Balkan committed
80
81
82
83
84
85
86
87
## Like this? Fund us!

[Small Technology Foundation](https://small-tech.org) is a tiny, independent not-for-profit.

We exist in part thanks to patronage by people like you. If you share [our vision](https://small-tech.org/about/#small-technology) and want to support our work, please [become a patron or donate to us](https://small-tech.org/fund-us) today and help us continue to exist.

## Copyright

88
© 2019-present [Aral Balkan](https://ar.al), [Small Technology Foundation](https://small-tech.org).
Aral Balkan's avatar
Aral Balkan committed
89

Aral Balkan's avatar
Aral Balkan committed
90
91
## License

92
[AGPL version 3.0](https://www.gnu.org/licenses/agpl-3.0.en.html)
Aral Balkan's avatar
Aral Balkan committed
93

Aral Balkan's avatar
Aral Balkan committed
94
<!-- Yes, this has to be coded like it’s 1999 for it to work, sadly. -->
Aral Balkan's avatar
Aral Balkan committed
95
<p align='center'><img width='76' src='images/illustrations/site.js-logo.svg' alt='Site.js logo: a small sprouting plant with a green leaf on either side of a brown stem'></p>