v0.0.4

* Removed legacy converter * Updated security issue in NPM package * Improved documentation * Added .htaccess * More Promises in Generator * Fixed escaping in HTML * Posts without links added * Twitter card added * OG:Image * Fixed broken sitemap
fboes · Aug 8, 2016 · 327e65f · 327e65f
1 parent 94fe554
commit 327e65f
Show file tree

Hide file tree

Showing 18 changed files with 336 additions and 261 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ user/posts/*
 !user/posts/.gitkeep
 htdocs/*
 !htdocs/robots.txt
+!htdocs/.htaccess
diff --git a/LICENSE → LICENSE.txt b/LICENSE → LICENSE.txt
diff --git a/README.md b/README.md
@@ -1,15 +1,45 @@
 Blogophon
 =========
 
-* Generate HTML-Files from Markdown
-* Templating via Mustache
-* Generate teaser page(s)
-* Generate tag page(s)
-* How to include meta stuff in head
+[![Dependency Status](https://david-dm.org/fboes/blogophon/status.svg)](https://david-dm.org/fboes/blogophon)
+[![devDependency Status](https://david-dm.org/fboes/blogophon/status.svg)](https://david-dm.org/fboes/blogophon#info=devDependencies)
 
+A small and simple Static Site Generator for blogs.
 
-To-do
------
+Features
+--------
 
-* Single file add
-* Dropbox ;)
+* Generate HTML-Files from Markdown.
+* Templating via Mustache.
+* Generate teaser page(s).
+* Generate tag page(s).
+* Will scale images.
+* Puts all relevant meta stuff into `<head>`.
+
+Installation
+------------
+
+1. Run `npm install` to install all dependencies.
+1. Create the `user/config.json` from `user/_config.json` and fill out the necessary variables.
+1. Optional: Change the template files in `theme`.
+
+How it works
+------------
+
+1. Start Gulp watcher via `gulp watch`.
+1. Create new Markdown file in `user/posts`. Do not use any other characters for the filename but letters, numbers, dashes and dots.
+1. Optional: Create images in a folder having the same name as the Markdow file you just created.
+1. Gulp will automatically create all HTML files.
+1. Optional: Use `rsync` to move your HTML files to any remote server you like.
+
+Version
+-------
+
+Version: 0.0.4 (2016-08-08)
+
+Legal stuff
+-----------
+
+Author: [Frank Boës](http://3960.org)
+
+Copyright & license: See [LICENSE.txt](LICENSE.txt)
diff --git a/converter.js b/converter.js
diff --git a/htdocs/.htaccess b/htdocs/.htaccess
@@ -0,0 +1,5 @@
+AddType text/xml rss
+AddType text/xml xml
+AddType text/plain md
+AddType application/json .json
+AddCharset utf-8 .html .css .js .rss .xml .md .json
diff --git a/htdocs/robots.txt b/htdocs/robots.txt
@@ -1,4 +1,4 @@
-# robots.txt zu http://www.example.org/
+# http://www.robotstxt.org/
 
 User-agent: *
 Sitemap: http://journal.3960.org/sitemap.xml
diff --git a/index.js b/index.js
@@ -9,6 +9,10 @@ Generator
     function (post) {
       Generator.buildAllPages();
       Generator.copyImages();
+      if(process.argv[2] !== undefined && process.argv[2] === '--deploy') {
+        Generator.deploy();
+      }
     }
   )
 ;
+