Merge pull request #11 from Klemek/dev

v1.2.0
Updated coverage
2019-06-26 19:00:30 +02:00 · 2019-06-26 18:56:01 +02:00 · 2019-06-26 18:44:31 +02:00 · 2019-06-26 18:43:41 +02:00 · 2019-06-26 18:34:40 +02:00 · 2019-06-26 18:21:44 +02:00
14 changed files with 110 additions and 27 deletions
@@ -3,6 +3,7 @@
 /config.json
 /config.example.json
 /data
+/data/*
 /test_data
 /access.log
 /error.log
@@ -132,7 +132,10 @@ You need to [create a new repository](https://github.com/new) on your favorite G
 ```bash
 #gitblog.md/
 cd data
+git init
 git remote add origin <url_of_your_repo.git>
+git add .
+git commit -m "initial commit"
 git push -u origin master
 ```

@@ -157,7 +160,7 @@ Here are the steps for Github, if you use another platform adapt it your way (he
 ```json
 "webhook": {
    "endpoint": "/webhook",
-    "secret": "sha1=<value>",
+    "secret": "<value>",
    "signature_header": "X-Hub-Signature"
  },
 ```
@@ -232,6 +235,12 @@ Any URL like `/year/month/day/anything/` will redirect to this article (and link
   * `plantuml` (default: true)  
     activate PlantUML diagram rendering
 * `home`
+   * `title` (default: GitBlog.md)  
+     the title of your blog, **strongly advised to be changed**  
+     given to the template to complete page title and metadata
+   * `description` (default: A static blog using Markdown pulled from your git repository)  
+     the description of your blog, **strongly advised to be changed**  
+     given to the template to complete page title and metadata
   * `index` (default: index.ejs)  
     the name of the home page template on the data directory  
     it will receive `articles`, a list of articles for rendering
@@ -1,6 +1,6 @@
 {
  "name": "gitblog.md",
-  "version": "1.1.1",
+  "version": "1.2.0",
  "description": "A static blog using Markdown pulled from your git repository.",
  "main": "src/server.js",
  "dependencies": {
@@ -2,8 +2,8 @@
 <html lang="en">
 <head>
    <meta charset="UTF-8">
-    <title>Error <%= error %></title>
-    <link rel="stylesheet" type="text/css" href="/style.css">
+    <title><%= info.title %> - Error <%= error %></title>
+    <%- include('head'); %>
 </head>
 <body>
 <main>
@@ -1,6 +1,6 @@
 <hr>
 <footer>
-    <small><a href="/rss">RSS feed</a> - @<%= new Date().getFullYear() %> - Made with <a
+    <small><a href="/rss">RSS feed</a> - <%= new Date().getFullYear() %> - Made with <a
                href="https://github.com/klemek/gitblog.md">GitBlog.md</a> (v<%= info.version %>)
    </small>
-</footer>
+</footer>
@@ -0,0 +1,25 @@
+<meta name="twitter:card" content="summary_large_image">
+<% if(locals.article){ %>
+    <%- `<meta property="og:title" content="${info.title} - ${article.title}">` %>
+    <%- `<meta property="twitter:title" content="${info.title} - ${article.title}">` %>
+    <%- `<meta property="og:description" content="${info.description}">` %>
+    <%- `<meta property="twitter:description" content="${info.description}">` %>
+    <%- `<meta property="org:url" content="${info.host + article.url}">` %>
+    <% if (article.thumbnail) { %>
+        <%- `<meta property="og:image" content="${info.host}/${article.thumbnail}">` %>
+        <%- `<meta property="twitter:image" content="${info.host}/${article.thumbnail}">` %>
+    <% } %>
+    <link rel="stylesheet" type="text/css" href="/prism.css">
+<% } else { %>
+    <%- `<meta property="og:title" content="${info.title} - Home">` %>
+    <%- `<meta property="twitter:title" content="${info.title} - Home">` %>
+    <%- `<meta property="og:description" content="${info.description}">` %>
+    <%- `<meta property="twitter:description" content="${info.description}">` %>
+    <%- `<meta property="org:url" content="${info.host}/">` %>
+<% } %>
+
+<link rel="alternate" type="application/rss+xml" title="RSS feed" href="/rss"/>
+
+<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
+
+<link rel="stylesheet" type="text/css" href="/style.css">
@@ -2,13 +2,13 @@
 <html lang="en">
 <head>
    <meta charset="UTF-8">
-    <title>GitBlog.md - Home</title>
-    <link rel="stylesheet" type="text/css" href="style.css">
+    <title><%= info.title %> - Home</title>
+    <%- include('head'); %>
 </head>
 <body>
 <main>
-    <h1>GitBlog.md</h1>
-    A static blog using Markdown pulled from your git repository
+    <h1><%= info.title %></h1>
+    <%= info.description %>
    <h2>Articles in this blog :</h2>
    <% articles.forEach((article) => { %>
        <div class="article">
@@ -8,7 +8,7 @@ body, html {
 }

 body {
-    font: 14px/1.45 -apple-system, BlinkMacSystemFont, Segoe UI, sans-serif;
+    font: 15px sans-serif;
    color: #111;
    -webkit-text-size-adjust: none;
    background-color: #F5F5F5;
@@ -16,8 +16,8 @@ body {
 }

 main {
-    max-width: 75ch;
-    padding: 2ch;
+    max-width: 42rem;
+    padding: 2rem;
    margin: auto;
    background-color: #F0F0F0;
    min-height: 100vh;
@@ -58,7 +58,7 @@ blockquote {
    border-left: 0.5em solid #ccc;
    padding-left: 1em;
    margin: 0.25em 0;
-    color: #333;
+    color: #555;
 }

 blockquote > p {
@@ -108,7 +108,7 @@ main.article div.header a.link-home {
    line-height: 2.4;
 }

-main.article div.header h1, main.article div.header h2, div.article h3 {
+main.article div.header h1, main.article div.header h2 {
    margin-top: 0.85em;
    margin-bottom: 0.25em;
    font-size: 2em;
@@ -123,11 +123,19 @@ main.article div.header span.time, div.article span.time {
 }

 div.article {
-    margin-left: 1em;
+    margin: 0 1em 1em 1em;
 }

 div.article h3 {
    font-size: 1.3em;
+    margin:0;
+}
+
+div.article img{
+    max-width: 100%;
+    height: auto;
+    margin-right:1em;
+    margin-top:0.25em;
 }

 #text {
@@ -142,4 +150,4 @@ div.article h3 {
 #text img {
    max-width: 100%;
    height: auto;
-}
+}
@@ -2,9 +2,8 @@
 <html lang="en">
 <head>
    <meta charset="UTF-8">
-    <title>GitBlog.md - <%= article.title %></title>
-    <link rel="stylesheet" type="text/css" href="/prism.css">
-    <link rel="stylesheet" type="text/css" href="/style.css">
+    <title><%= info.title %> - <%= article.title %></title>
+    <%- include('head'); %>
 </head>
 <body>
 <main class="article">
@@ -19,4 +18,4 @@
    <%- include('footer'); %>
 </main>
 </body>
-</html>
+</html>
@@ -36,6 +36,7 @@ module.exports = (config) => {

  const articles = {};
  let lastRSS = '';
+  let host;

  /**
   * Fetch articles from the data folder and send success as a response
@@ -73,6 +74,9 @@ module.exports = (config) => {
   */
  const render = (res, vPath, data, code = 200) => {
    data.info = {
+      title: config['home']['title'],
+      description: config['home']['description'],
+      host: host,
      version: pjson.version
    };
    res.render(vPath, data, (err, html) => {
@@ -100,6 +104,14 @@ module.exports = (config) => {
    });
  };

+  app.use((req, res, next) => {
+    if (!host) {
+      host = 'http://' + req.headers.host;
+      console.log(cons.ok, 'Currently hosted on ' + host);
+    }
+    next();
+  });
+
  //log request at result end
  app.use((req, res, next) => {
    if (config['access_log']) {
@@ -148,7 +160,7 @@ module.exports = (config) => {
          });
        lastRSS = feed.xml();
      }
-      res.type('rss').send(lastRSS);
+      res.type(req.headers['user-agent'].match(/Mozilla/) ? 'text/xml' : 'rss').send(lastRSS);
    } else {
      showError(req.path, 404, res);
    }
@@ -225,7 +237,7 @@ module.exports = (config) => {
  });

  // serve all static files via get
-  app.get('*', express.static(config['data_dir']));
+  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);
@@ -12,6 +12,8 @@
    "plantuml": true
  },
  "home": {
+    "title": "GitBlog.md",
+    "description": "A static blog using Markdown pulled from your git repository",
    "index": "index.ejs",
    "error": "error.ejs",
    "hidden": [
@@ -35,7 +37,7 @@
    "endpoint": "/webhook",
    "secret": "",
    "signature_header": "",
-    "pull_command": "git pull"
+    "pull_command": "git pull origin master"
  },
  "showdown": {
    "parseImgDimensions": true,
@@ -52,4 +54,4 @@
  "plantuml": {
    "output_format": "svg"
  }
-}
+}
@@ -10,6 +10,10 @@ const fs = require('fs');
 const merge = (ref, src) => {
  if (typeof ref !== typeof src) {
    return ref;
+  } else if (ref.length && !src.length) {
+    return ref;
+  } else if (ref.length && src.length) {
+    return src;
  } else if (typeof ref === 'object') {
    const out = {};
    Object.keys(ref).forEach((key) => out[key] = merge(ref[key], src[key]));
@@ -175,11 +175,19 @@ describe('Test RSS feed', () => {
  test('200 empty rss', (done) => {
    request(app).get('/rsstest').then((response) => {
      expect(response.statusCode).toBe(200);
+      expect(response.type).toBe('application/rss+xml');
      expect(response.text.length).toBeGreaterThan(0);
      expect(response.text.split('<item>').length).toBe(1);
      done();
    });
  });
+  test('200 Mozilla fix', (done) => {
+    request(app).get('/rsstest').set('user-agent', 'Mozilla Firefox 64.0').then((response) => {
+      expect(response.statusCode).toBe(200);
+      expect(response.type).toBe('text/xml');
+      done();
+    });
+  });
  test('200 rss cache', (done) => {
    request(app).get('/rsstest').then(() => {
      request(app).get('/rsstest').then((response) => {
@@ -385,9 +393,10 @@ describe('Test static files', () => {
    });
  });
  test('200 valid file', (done) => {
-    fs.writeFileSync(path.join(dataDir, 'somefile.txt'), 'filecontent');
-    request(app).get('/somefile.txt').then((response) => {
+    fs.writeFileSync(path.join(dataDir, 'somefile.css'), 'filecontent');
+    request(app).get('/somefile.css').then((response) => {
      expect(response.statusCode).toBe(200);
+      expect(response.type).toBe('text/css');
      expect(response.text).toBe('filecontent');
      done();
    });
@@ -64,4 +64,18 @@ test('wrong config fixed', () => {
  expect(config).toBeDefined();
  expect(config['node_port']).toBe(3000);
  expect(config['data_dir']).toBe('data2');
+});
+
+test('array parsing', () => {
+  fs.writeFileSync(configFile, '{"home":{"hidden":["item1","item2"]}}');
+  const config = require('../src/config')();
+  expect(config).toBeDefined();
+  expect(config['home']['hidden']).toEqual(['item1', 'item2']);
+});
+
+test('array fix', () => {
+  fs.writeFileSync(configFile, '{"home":{"hidden":{}}}');
+  const config = require('../src/config')();
+  expect(config).toBeDefined();
+  expect(config['home']['hidden']).toEqual(['.ejs']);
 });
Author	SHA1	Message	Date
Klemek	ea95a285c9	Merge pull request #11 from Klemek/dev v1.2.0	2019-06-26 19:00:30 +02:00
Klemek	0fde428806	Updated coverage	2019-06-26 18:56:01 +02:00
Klemek	8fc7ff1ca7	Updated version	2019-06-26 18:44:31 +02:00
Klemek	ae4e2eb8d5	Fixing Firefox RSS handling	2019-06-26 18:43:41 +02:00
Klemek	528e4be1fe	Updated templates	2019-06-26 18:34:40 +02:00
Klemek	bd42883330	Update template.ejs	2019-06-26 18:21:44 +02:00
Klemek	b6ac0a73b4	Update style.css	2019-06-26 18:21:26 +02:00
Klemek	aebc3da5bc	Update template.ejs	2019-06-26 16:43:03 +02:00
Klemek	7a4a4f9006	Update footer.ejs	2019-06-26 15:07:32 +02:00
Klemek	1341aa5a56	Update config.default.json	2019-06-26 11:46:06 +02:00
Klemek	5e05f250f4	Update style.css	2019-06-26 10:06:12 +02:00
Klemek	6cf7be3afb	Update README.md	2019-06-23 15:37:23 +02:00
Klemek	6aceacad18	Update README.md	2019-06-23 15:34:46 +02:00
Klemek	a3a23be1c2	Update README.md	2019-06-23 15:34:34 +02:00
Klemek	e8e8024021	Merge pull request #10 from Klemek/dev v1.1.5	2019-06-23 15:15:45 +02:00
Klemek	1806d60ca7	Fixed meta tags being wrong	2019-06-23 15:14:47 +02:00
Klemek	2c5f2e589f	Merge pull request #9 from Klemek/dev v1.1.4	2019-06-23 15:09:27 +02:00
Klemek	847d228c0a	Updated templates	2019-06-23 15:06:15 +02:00
Klemek	576948acee	ViewPort property	2019-06-23 15:05:06 +02:00
Klemek	fa6d91db20	updated README.md	2019-06-23 15:04:15 +02:00
Klemek	989bcdf130	Pages metadata by default	2019-06-23 15:02:33 +02:00
Klemek	000104c99d	Merge pull request #8 from Klemek/dev v1.1.3	2019-06-23 14:46:52 +02:00
Klemek	f2bd0ec10e	Fixed config merge	2019-06-23 14:44:32 +02:00
Klemek	97dab302d8	Merge pull request #7 from Klemek/dev v1.1.2	2019-06-23 14:19:24 +02:00
Klemek	55e258e093	Fixed Express.static mime type	2019-06-23 14:14:35 +02:00