JServ/static_sites_generation_example
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Init commit

Browse Source
This commit is contained in:
Moutonjr Geoff 2020-11-21 15:08:16 +01:00
commit 6d7d598290
6 changed files with 86 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
public/
package-lock.json
node_modules/

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# Test static site generation
## Introduction
This small snippet aims to convince that you can render all static pages at once using SSG-scheme.
## OK, what should I see?
Scheme is as follows:
- Aim is to deliver plain ol' HTML pages by web server. No, no application server accepted; This is best for most of services!
- Problem: You have redundant content, and you don't want the hassle to maintain HTML files:
- No functions, so redundant code;
- Can't properly handle modular breakdown (header, footer, sections);
- When you made it work once, shall you re-understand everything 6 months later to thange stubs?
Here is how it works:
- We store relevant data in a YAML file, say `settings.yml`.
- We Use [Nunjucks](https://mozilla.github.io/nunjucks/templating.html), the millenials way to code, to generate Jinja2-styled webpages on steroids.
- We Then compile the whole _once_, and after we got static HTML for basically every use.
What repo doesn't contain:
- All Nunjucks killer features.
## Dependencies
Install NodeJS and npm
## Build
```bash
npm run build
```
Serve your webserver to display the `public` folder as webroot.

23
build.js Normal file
View File

@ -0,0 +1,23 @@
const nunjucks = require('nunjucks');
const fs = require('fs');
const yaml = require('js-yaml');
const ENTRY_POINT='templates/index.njk';
const OUTPUT_POINT='public/index.html';
const GLOBAL_SETTINGS='./settings.yml';
try {
let fileContents = fs.readFileSync(GLOBAL_SETTINGS, 'utf8');
let settings = yaml.safeLoad(fileContents);
console.log(data);
} catch (e) {
console.log(e);
}
var data = nunjucks.render(ENTRY_POINT, settings);
fs.writeFile(OUTPUT_POINT, data, 'utf-8', function(err){
if (err) return console.log(err);
});

19
package.json Normal file
View File

@ -0,0 +1,19 @@
{
"name": "test",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"prebuild": "rm -rf public/ && mkdir public/",
"install": "npm run build",
"build": "node build.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"dependencies": {
"fs": "0.0.1-security",
"js-yaml": "^3.14.0",
"nunjucks": "^3.2.2"
}
}

3
settings.json Normal file
View File

@ -0,0 +1,3 @@
{
"dinner": "ready"
}

8
templates/index.njk Normal file
View File

@ -0,0 +1,8 @@
<!DOCTYPE html>
<html>
<body>
<p>
Dinner is {{ dinner }}
</p>
</body>
</html>