update to latest status
parent
b8787ce475
commit
fd9afa2f7a
16
README.md
16
README.md
|
@ -8,7 +8,7 @@ The page is visible at [publiccode.eu](https://publiccode.eu). Please do not spr
|
|||
|
||||
### Prerequisites
|
||||
|
||||
In order to modify the website, you need `hugo` and `git` installed on your computer. If Hugo isn't available in your package manager, obtain it from its [official website](https://gohugo.io). We tested the website build with Hugo from version 0.19 upwards. Please make sure that you use an as recent version as possible to avoid errors.
|
||||
In order to modify the website, you need `hugo` and `git` installed on your computer. If Hugo isn't available in your package manager, obtain it from its [official website](https://gohugo.io). We tested the website build with Hugo from version 0.20.7 upwards. Please make sure that you use an as recent version as possible to avoid errors.
|
||||
|
||||
### Configuring Git
|
||||
|
||||
|
@ -16,7 +16,7 @@ First of all, you'll need an account on git.fsfe.org. With an FSFE account (FSFE
|
|||
|
||||
As part of the campaign team you can get full write access to this repository. Please contact one of [pmpc](https://git.fsfe.org/pmpc)'s admins to give your account the necessary privileges.
|
||||
|
||||
In the FSFE's wiki, you'll find [information about our Git server](https://wiki.fsfe.org/TechDocs/Git) installation, and some guides for basic procedures.
|
||||
In the FSFE's wiki, you'll find [information about our Git server](https://wiki.fsfe.org/TechDocs/Git) installation, and some guides for basic procedures like configuration, commits, and pushes.
|
||||
|
||||
### Cloning the website
|
||||
|
||||
|
@ -28,7 +28,7 @@ cd ~/FSFE/PMPC/ # go to the newly created PMPC d
|
|||
git clone git@git.fsfe.org:pmpc/website.git # clone the website to the folder website
|
||||
```
|
||||
|
||||
In the newly created folder `pmpc-website` you'll find all source files the website consists of now. The hugo files are located under site/, whereas in the root directory you'll only find files informational files and those relevant for our build process (Drone, Ansible, Docker, Apache).
|
||||
In the newly created folder `pmpc-website` you'll find all source files the website consists of now. The hugo files are located under `site/`, whereas in the root directory you'll only find files informational files and those relevant for our build process (Drone, Ansible, Docker, Apache).
|
||||
|
||||
### Your first modification
|
||||
|
||||
|
@ -51,13 +51,15 @@ As an example, we will modify the website a bit, review the changes and push the
|
|||
|
||||
The website structure is very easy. The most important files and directories are:
|
||||
|
||||
- `site/config.toml`: Headlines, site title, many texts.
|
||||
- `site/data/resources/`: Content of the 3-column "resource" boxes which you can hover over and click to see the text.
|
||||
- `site/data/share/`: Services where people can share to. Is being used in the "Spread" section and the left-side sharing icons
|
||||
- `site/config-static.toml`: Static texts and URLs which are the same for any language
|
||||
- `site/languages/strings.{en,fr...}.toml`: Headlines, site title, many texts for the various languages.
|
||||
- `site/content`: Markdown-files for sub-pages like /openletter, can be translated
|
||||
- `site/data/{en,de...}/share`: Services and their very short translatable strings where people can share to. Is being used in the "Spread" section and the left-side sharing icons
|
||||
- `site/static/`: CSS, images, and Javascript files for the design.
|
||||
- `site/static/img/share/`: Image files for share buttons.
|
||||
- `site/static/css/custom.css`: File where all custom CSS code should be written to.
|
||||
- `site/layouts/`: HTML structure (scaffold) for the website. Useful if you want to add another section or modify anchor links or CSS classes.
|
||||
- `site/layouts/page`: Template for a sub-page like /privacy
|
||||
- `site/layouts/shortcodes`: HTML/Hugo code which can be important from within a Markdown file
|
||||
- `site/public/`: Built files which are used to display the website. Generated by running `hugo`.
|
||||
|
||||
## Technical information about building
|
||||
|
|
Loading…
Reference in New Issue