From 3bb7a6fb154de6204da786e6cc24e637cfc20bd1 Mon Sep 17 00:00:00 2001 From: Moutonjr Geoff Date: Sat, 21 Nov 2020 15:18:19 +0100 Subject: [PATCH] Add YML instead of JSON, simplifying README --- README.md | 13 +++++++++---- build.js | 10 +++------- settings.json | 3 --- settings.yml | 2 ++ 4 files changed, 14 insertions(+), 14 deletions(-) delete mode 100644 settings.json create mode 100644 settings.yml diff --git a/README.md b/README.md index 808766d..e7411f0 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,17 @@ Scheme is as follows: - 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: +#### What should I open? +- `template/index.njk` is a good start, +- then `settings.yml`, +- Then run the script and see the `public/index.html` folder. It explains it all. + +#### 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. +- We Then compile the whole _once_, and after we got static HTML in `public/` folder for basically every use. -What repo doesn't contain: +#### What this repo doesn't contain: - All Nunjucks killer features. ## Dependencies @@ -24,7 +29,7 @@ Install NodeJS and npm ## Build ```bash - npm run build + npm install ``` Serve your webserver to display the `public` folder as webroot. diff --git a/build.js b/build.js index 6e824d0..8fb3515 100644 --- a/build.js +++ b/build.js @@ -10,14 +10,10 @@ try { let fileContents = fs.readFileSync(GLOBAL_SETTINGS, 'utf8'); let settings = yaml.safeLoad(fileContents); - console.log(data); + var data = nunjucks.render(ENTRY_POINT, settings); + fs.writeFile(OUTPUT_POINT, data, 'utf-8'); + } 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); -}); - diff --git a/settings.json b/settings.json deleted file mode 100644 index 1be7914..0000000 --- a/settings.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "dinner": "ready" -} diff --git a/settings.yml b/settings.yml new file mode 100644 index 0000000..2b5e1ae --- /dev/null +++ b/settings.yml @@ -0,0 +1,2 @@ +--- +dinner: "ready"