Skip to content

Commit 7f4aeec

Browse files
author
Thierry Boileau
committed
cleanup useless files
1 parent f1bb65b commit 7f4aeec

4 files changed

Lines changed: 35 additions & 1 deletion

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Introduction
2+
3+
The Website of the Restlet Framework is developed with Hugo: https://gohugo.io/
4+
5+
That's a great rule to test any update locally, so install Hugo: https://gohugo.io/installation/
6+
Then run `hugo server` and reach http://localhost:1313.
7+
8+
Hugo allows live updates, which is a very nice feature.
9+
However, once you're done with your updates:
10+
11+
- stop the server
12+
- drop these two directories: `./public` and `./resources`
13+
- run again `hugo server`
14+
It's a great habit to check your updates.
15+
16+
# Directories
17+
18+
| Directory | Comment |
19+
|-----------|-------------------------------------------------------------------------------------------------------|
20+
| `assets` | SASS files that are transpiled into CSS |
21+
| `content` | pages of the Website: this is the main place for your updates |
22+
| `data` | yaml files to be used in layout code (cf themes/restlet-framework/layouts/_shortcodes/downloads.html) |
23+
| `static` | CSS, JS files |
24+
| `themes` | the definition of the layout |
25+
26+
# Layouts and partials
27+
28+
Pages are organized by their main directory:
29+
- the pages inside the root directory
30+
- the pages inside the `downloads` directory
31+
- the pages inside the `documentation` directory
32+
- the pages inside the `documentation/changelog` directory
33+
34+
They are handled by the `baseof.html` template of the exact same directory in the layouts `./themes/restlet-framework/layouts`. As you can notice, there is no `downloads` directory: the layout in the root directory applies.
35+
Layout include what is called `partials` (located in `./themes/restlet-framework/partials`) this is where all the logic of html code generation resides.

themes/restlet-framework/assets/css/main.css

Whitespace-only changes.

themes/restlet-framework/assets/js/main.js

Lines changed: 0 additions & 1 deletion
This file was deleted.
-15 KB
Binary file not shown.

0 commit comments

Comments
 (0)