Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Klemek
|
bedd6a2953 | ||
|
Klemek
|
52d37d56cd | ||
|
Klemek
|
fc7bc63c46 | ||
|
Klemek
|
4397a76d9b | ||
|
Klemek
|
ddf964eb27 | ||
|
Klemek
|
4b47276484 | ||
|
Klemek
|
a7fedb149f | ||
|
Klemek
|
ea95a285c9 | ||
|
Klemek
|
0fde428806 | ||
|
Klemek
|
8fc7ff1ca7 | ||
|
Klemek
|
ae4e2eb8d5 | ||
|
Klemek
|
528e4be1fe | ||
|
Klemek
|
bd42883330 | ||
|
Klemek
|
b6ac0a73b4 | ||
|
Klemek
|
aebc3da5bc | ||
|
Klemek
|
7a4a4f9006 | ||
|
Klemek
|
1341aa5a56 | ||
|
Klemek
|
5e05f250f4 | ||
|
Klemek
|
6cf7be3afb | ||
|
Klemek
|
6aceacad18 | ||
|
Klemek
|
a3a23be1c2 | ||
|
Klemek
|
e8e8024021 | ||
|
Klemek
|
1806d60ca7 |
@@ -3,6 +3,7 @@
|
||||
/config.json
|
||||
/config.example.json
|
||||
/data
|
||||
/data/*
|
||||
/test_data
|
||||
/access.log
|
||||
/error.log
|
||||
|
||||
@@ -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.
|
||||
@@ -132,7 +156,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 +184,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"
|
||||
},
|
||||
```
|
||||
@@ -165,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)
|
||||
|
||||
@@ -212,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)
|
||||
|
||||
+12
-1
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "gitblog.md",
|
||||
"version": "1.1.4",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,17 +3,7 @@
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title><%= info.title %> - Error <%= error %></title>
|
||||
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<%= `<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}/">` %>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="/style.css">
|
||||
<%- 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">
|
||||
@@ -3,17 +3,7 @@
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title><%= info.title %> - Home</title>
|
||||
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<%= `<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}/">` %>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="style.css">
|
||||
<%- include('head'); %>
|
||||
</head>
|
||||
<body>
|
||||
<main>
|
||||
|
||||
@@ -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;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,22 +3,7 @@
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title><%= info.title %> - <%= article.title %></title>
|
||||
|
||||
<meta name="twitter:card" content="summary_large_image">
|
||||
<%= `<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="org:image" content="${info.host + article.thumbnail}">` %>
|
||||
<%= `<meta property="twitter:image" content="${info.host + article.thumbnail}">` %>
|
||||
<% } %>
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, shrink-to-fit=no">
|
||||
|
||||
<link rel="stylesheet" type="text/css" href="/prism.css">
|
||||
<link rel="stylesheet" type="text/css" href="/style.css">
|
||||
<%- include('head'); %>
|
||||
</head>
|
||||
<body>
|
||||
<main class="article">
|
||||
@@ -33,4 +18,4 @@
|
||||
<%- include('footer'); %>
|
||||
</main>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
||||
|
||||
+23
-20
@@ -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 code - error code
|
||||
* @param req
|
||||
* @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,23 +149,23 @@ module.exports = (config) => {
|
||||
const feed = new Rss({
|
||||
'title': config['rss']['title'],
|
||||
'description': config['rss']['description'],
|
||||
'feed_url': 'http://' + req.headers.host + req.url,
|
||||
'site_url': 'http://' + req.headers.host
|
||||
'feed_url': host + req.url,
|
||||
'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
|
||||
});
|
||||
});
|
||||
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);
|
||||
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
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
{
|
||||
"node_port": 3000,
|
||||
"host": "",
|
||||
"data_dir": "data",
|
||||
"view_engine": "ejs",
|
||||
"access_log": "access.log",
|
||||
@@ -37,7 +38,7 @@
|
||||
"endpoint": "/webhook",
|
||||
"secret": "",
|
||||
"signature_header": "",
|
||||
"pull_command": "git pull"
|
||||
"pull_command": "git pull origin master"
|
||||
},
|
||||
"showdown": {
|
||||
"parseImgDimensions": true,
|
||||
@@ -54,4 +55,4 @@
|
||||
"plantuml": {
|
||||
"output_format": "svg"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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) => {
|
||||
|
||||
Reference in New Issue
Block a user