Merge pull request #13 from Klemek/dev

v1.2.2

README.md

@@ -125,6 +125,30 @@ Resources are located on the `data` folder and can be referenced as the root of
 /styles/main.css => data/styles/main.css
 ```
 
+In your template, the following data is sent :
+
+* `info`  (every pages)
+  * `title` :  the blog's title as in the config
+  * `description` the blog's description as in the config
+  * `host` : the specified or guessed host with the protocol
+  * `version` : the GitBlog.md current running version
+  * `request` : the Express request object
+  * `config` : the content of the config
+* `article` (article pages only)
+  * `title` : the full title
+  * `thumbnail` the URL path of the thumbnail
+  * `url` : the URL path for this article (with the title)
+  * `date` : a JS date
+  * `year`
+  * `month`
+  * `day`
+  * `path` : the URL path for the folder of the article (without the title)
+  * `realPath` : the system's path for the folder
+  * `escapedTitle` : the code with alphanumeric and underscore characters only
+* `error` (error pages only)
+  * `error` : the error code
+  * `path` : the resource that caused the error
+
 #### 5. Create and init your git source
 
 You need to [create a new repository](https://github.com/new) on your favorite Git service.
@@ -168,6 +192,14 @@ Here are the steps for Github, if you use another platform adapt it your way (he
 * Update your webhook on github to include the secret
 * Check if Github successfully reached the endpoint
 
+#### 8. Keep your server always up and running (optionnal)
+
+This project `package.json` comes with a [nodemon](https://github.com/remy/nodemon) config. 
+
+After installing (`npm i -g nodemon`) you can then run the app with juste the `nodemon` command in the working directory.
+
+With this method, you can do a simple `git pull` to update your server.
+
 ## Writing an article
 [back to top](#gitblog-md)
 
@@ -215,6 +247,9 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
 
 *  `node_port` (default: 3000)  
   the port the server is listening to
+*  `host` (default: none)  
+  if set (like `https://mywebsite.com`, it will be used as reference for creating links  
+  by default, host is guessed based on first request
 * `data_dir` (default: data)  
   the directory where will be located the git repo with templates and articles
 * `view_engine` (default: ejs)  

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gitblog.md",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "A static blog using Markdown pulled from your git repository.",
   "main": "src/server.js",
   "dependencies": {
@@ -46,5 +46,16 @@
       "!src/postinstall.js",
       "!src/lib/*.js"
     ]
+  },
+  "nodemonConfig": {
+    "ignore": [
+      "test/*",
+      "sample_data/*",
+      "data/*",
+      "uml/*",
+      "*.log",
+      "README.md"
+    ],
+    "delay": "2500"
   }
 }

src/app.js

@@ -36,7 +36,7 @@ module.exports = (config) => {
 
   const articles = {};
   let lastRSS = '';
-  let host;
+  let host = config['host'];
 
   /**
    * Fetch articles from the data folder and send success as a response
@@ -67,17 +67,20 @@ module.exports = (config) => {
 
   /**
    * Render the page with the view engine and catch errors
+   * @param req
    * @param res
    * @param vPath - path of the view
    * @param data - data to pass to the view
    * @param code - code to send along the page
    */
-  const render = (res, vPath, data, code = 200) => {
+  const render = (req, res, vPath, data, code = 200) => {
     data.info = {
       title: config['home']['title'],
       description: config['home']['description'],
       host: host,
-      version: pjson.version
+      version: pjson.version,
+      request: req,
+      config: config
     };
     res.render(vPath, data, (err, html) => {
       if (err) {
@@ -90,17 +93,17 @@ module.exports = (config) => {
 
   /**
    * Show an error with the correct page
-   * @param resPath - the page of the original error
+   * @param req
-   * @param code - error code
    * @param res
+   * @param code - error code
    */
-  const showError = (resPath, code, res) => {
+  const showError = (req, res, code) => {
     const errorPath = path.join(config['data_dir'], config['home']['error']);
     fs.access(errorPath, fs.constants.R_OK, (err) => {
       if (err)
         res.sendStatus(code);
       else
-        render(res, errorPath, {error: code, path: resPath}, code);
+        render(req, res, errorPath, {error: code, path: req.path}, code);
     });
   };
 
@@ -133,9 +136,9 @@ module.exports = (config) => {
     const homePath = path.join(config['data_dir'], config['home']['index']);
     fs.access(homePath, fs.constants.R_OK, (err) => {
       if (err)
-        showError(req.path, 404, res);
+        showError(req, res, 404);
       else
-        render(res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
+        render(req, res, homePath, {articles: Object.values(articles).sort((a, b) => ('' + b.path).localeCompare(a.path))});
     });
   });
 
@@ -146,15 +149,15 @@ module.exports = (config) => {
         const feed = new Rss({
           'title': config['rss']['title'],
           'description': config['rss']['description'],
-          'feed_url': 'http://' + req.headers.host + req.url,
+          'feed_url': host + req.url,
-          'site_url': 'http://' + req.headers.host
+          'site_url': host
         });
         Object.values(articles)
           .slice(0, config['rss']['length'])
           .forEach((article) => {
             feed.item({
               title: article.title,
-              url: 'http://' + req.headers.host + article.url,
+              url: host + article.url,
               date: article.date
             });
           });
@@ -162,7 +165,7 @@ module.exports = (config) => {
       }
       res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
     } else {
-      showError(req.path, 404, res);
+      showError(req, res, 404);
     }
   });
 
@@ -205,21 +208,21 @@ module.exports = (config) => {
       const articlePath = req.path.substr(1, 10);
       const article = articles[articlePath];
       if (!article)
-        showError(req.path, 404, res);
+        showError(req, res, 404);
       else {
         renderer.render(path.join(article.realPath, config['article']['index']), (err, html) => {
           if (err) {
             console.log(cons.error, `failed to render article ${req.path} : ${err}`);
-            return showError(req.path, 500, res);
+            return showError(req, res, 500);
           }
           article.content = html;
           const templatePath = path.join(config['data_dir'], config['article']['template']);
           fs.access(templatePath, fs.constants.R_OK, (err) => {
             if (err) {
               console.log(cons.error, `no template found at ${templatePath}`);
-              showError(req.path, 500, res);
+              showError(req, res, 500);
             } else
-              render(res, templatePath, {article: article});
+              render(req, res, templatePath, {article: article});
           });
         });
       }
@@ -231,7 +234,7 @@ module.exports = (config) => {
   // catch all hidden file type and return 404
   app.get('*', (req, res, next) => {
     if (config['home']['hidden'].includes(path.extname(req.path)))
-      showError(req.path, 404, res);
+      showError(req, res, 404);
     else
       next();
   });
@@ -240,7 +243,7 @@ module.exports = (config) => {
   app.get('*', express.static(path.join(__dirname, '..', config['data_dir'])));
   // catch express.static errors (mostly not found) by displaying 404
   app.get('*', (req, res) => {
-    showError(req.path, 404, res);
+    showError(req, res, 404);
   });
 
   // catch all other methods and return 400

src/config.default.json

@@ -1,5 +1,6 @@
 {
   "node_port": 3000,
+  "host": "",
   "data_dir": "data",
   "view_engine": "ejs",
   "access_log": "access.log",