README.md 1.22 KB
Newer Older
Christoph Cullmann's avatar
Christoph Cullmann committed
1
# kate-editor.org
Christoph Cullmann's avatar
Christoph Cullmann committed
2

3
4
[![Build Status](https://binary-factory.kde.org/buildStatus/icon?job=Website_kate-editor-org)](https://binary-factory.kde.org/job/Website_kate-editor-org/)

Christoph Cullmann's avatar
Christoph Cullmann committed
5
6
This repository contains the full kate-editor.org website.

Christoph Cullmann's avatar
Christoph Cullmann committed
7
8
On push the https://binary-factory.kde.org/job/Website_kate-editor-org/ job will trigger an update of the web server.

9
10
# Live preview / Development
Details about the shared theme: [kde-hugo wiki](https://invent.kde.org/websites/aether-sass/-/wikis/Hugo)
Christoph Cullmann's avatar
Christoph Cullmann committed
11

12
If you don't want to touch the shared theme, just delete the _development_ config file `config/development/config.yaml` and uncomment the `hugo mod get ...` line in `server.sh`.
Christoph Cullmann's avatar
Christoph Cullmann committed
13

14
15
16
Then you can start a local hugo powered web server via

```bash
Christoph Cullmann's avatar
Christoph Cullmann committed
17
./server.sh
18
```
Christoph Cullmann's avatar
Christoph Cullmann committed
19
20
21

The command will print the URL to use for local previewing.

22
23
24
# I18n
[hugoi18n](https://invent.kde.org/websites/hugo-i18n)

Christoph Cullmann's avatar
Christoph Cullmann committed
25
26
# Update the syntax-highlighting framework update sites

27
Check out the README.md in the syntax-highlighting.git on invent.kde.org.
Christoph Cullmann's avatar
Christoph Cullmann committed
28

29
There is a build target to generate the needed stuff after a successful compile of the framework.
30
31
32
33
34
35
36
37
38
39

# Update auto-generated pages like "team" or "merge requests"

Just run

```bash
./regenerate.sh
```

and review the results before you commit them.