README.md 1.75 KB
Newer Older
1
2
3
4
# Website repository for gajim.org

This is the new [Hugo](https://gohugo.io)-powered website for gajim.org.

5
A preview of this site can be viewed here: https://devel.gajim.org/
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

---

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Website repository for gajim.org](#website-repository-for-gajimorg)
  - [Building locally](#building-locally)
    - [Preview your site](#preview-your-site)
  - [GitLab CI](#gitlab-ci)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Building locally

This website can be viewd and modified on your local machine.
To work locally, follow the steps below:

1. Fork, clone or download website-dev
2. [Install](https://gohugo.io/overview/installing/) Hugo
3. Preview Gajim's website locally: `hugo server`
4. Add or modify content

If you want to modify files in the `content` directory, please change files in
the `en` directory only. Content for other languages will be generated from our
translation service at [translate.gajim.org](https://translate.gajim.org/).

Read more at Hugo's [documentation](https://gohugo.io/overview/introduction/).

### Preview your site

If you clone or download this project to your local computer and run `hugo server`,
39
the site can be accessed under `localhost:1313`.
40
41
42
43
44
45
46
47
48
49

The theme used for gajim.org is adapted from http://themes.gohugo.io/beautifulhugo/.

## GitLab CI

Static pages of gajim.org are built by [GitLab CI](https://about.gitlab.com/gitlab-ci/), following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml).

Learn more about [GitLab Pages](https://pages.gitlab.io) and the [official
documentation](https://docs.gitlab.com/ce/user/project/pages/).