From 7a5a585ead8c4e967980adc2ab9c7502e47694fd Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Sun, 2 Jul 2017 21:31:10 -0500 Subject: 💄📝 Add basic static layout + readme/contributing MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit f32ca088e9b4d9c6b6edad5271757d886f7177e8 Author: Ben Beltran Date: Sun Jul 2 21:30:20 2017 -0500 Add CHANGELOG commit f5691219950c7546343d42791034cdbba748609b Author: Ben Beltran Date: Sun Jul 2 21:30:00 2017 -0500 Add mac files, and generated files to ignore commit 88ba8c1bed6a6336e1c0ebb5e5d42210a20422a7 Author: Ben Beltran Date: Sun Jul 2 21:28:34 2017 -0500 Add contributing guide commit 160eae6998e2559b6b9e3b21473c930b10278739 Author: Ben Beltran Date: Sun Jul 2 21:24:21 2017 -0500 Add readme commit 36760ff85dbd335afe2c5d9ea9596f81a0ca88a3 Author: Ben Beltran Date: Sun Jul 2 21:11:47 2017 -0500 💄 Add static layout --- README.md | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2634854..7f7903a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # blog -A temporary blog + +Blog at unlimited.pizza -> Only + +## How to install + +`npm install -g .` will expose the `blog` binary to your CLI. + +## How to add a new entry + +Create a directory with a `.md` markdown file, and an `/assets` +directory with anything you want in there. This can be in any directory. + +``` +. +└── this-is-an-example-post + ├── assets + │   └── example.png + └── this-is-an-example-post.md +``` + +You can add this to the blog using the following command, it will shift +all entries and remove the oldest one if limit of posts is reached +(defualts to 3): + +`blog --add path/to/blog_post` + +These commands will regenerate the static files. At that point you can +preview your blog by serving the files on the `static` directory. + +If you need to make corrections use: + +`blog --update path/to/blog_post` + +This will replace the latest with the contents of the `path` without +shifting the existing entries. + +`blog --publish` + +Will publish the blog. -- cgit From 397444675d7156acd6495223a3b15175d6853589 Mon Sep 17 00:00:00 2001 From: Ben Beltran Date: Mon, 3 Jul 2017 00:52:43 -0500 Subject: 🐛✨📝 Add quick access, favicons and fix publish cmd MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Squashed commit of the following: commit 294b1de9d8d64f8356227b634091c3fd7982346b Author: Ben Beltran Date: Mon Jul 3 00:52:16 2017 -0500 ✨ Add quick access in frontend commit 70acd1f292c6bbfb6596a21bf0106837c85bf2f0 Author: Ben Beltran Date: Mon Jul 3 00:46:51 2017 -0500 Add pizza favicons commit b72471650a7632a1cead64ca9dab2210add13699 Author: Ben Beltran Date: Mon Jul 3 00:39:45 2017 -0500 📝 Correct missing entries in changelog commit 03b9fa8f7ae47a318dbde8bd245988b64cefe66f Author: Ben Beltran Date: Mon Jul 3 00:39:20 2017 -0500 📝 Add docs about publishing with surge commit 710cd3b3bf4a4f913d99addad69efc751a74611f Author: Ben Beltran Date: Mon Jul 3 00:38:06 2017 -0500 🐛 Fix publish command --- CHANGELOG.md | 2 ++ README.md | 8 ++++++++ bin/blog.js | 2 +- static/favicon.ico | Bin 0 -> 5430 bytes static/favicon.png | Bin 0 -> 3807 bytes static/js/blog.js | 28 ++++++++++++++++++++++++++++ templates/index.html | 2 ++ 7 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 static/favicon.ico create mode 100644 static/favicon.png create mode 100644 static/js/blog.js (limited to 'README.md') diff --git a/CHANGELOG.md b/CHANGELOG.md index 728047b..f5d320d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] ### Added +- JSDoc config +- Eslint config - Binary to add and update blog posts - Template for index - Static Files diff --git a/README.md b/README.md index 7f7903a..4713730 100644 --- a/README.md +++ b/README.md @@ -38,3 +38,11 @@ shifting the existing entries. `blog --publish` Will publish the blog. + +## How to publish + +At the moment, the app does not include any publishers. [surge][surge] is an easy +way to do it, just point it to your static directory. + + +[surge]: https://surge.sh diff --git a/bin/blog.js b/bin/blog.js index c88a8aa..5d27d4a 100755 --- a/bin/blog.js +++ b/bin/blog.js @@ -33,7 +33,7 @@ const internals = { } if (argument === 'publish') { - await internals.blog.update(value); + await internals.blog.publish(value); return; } } diff --git a/static/favicon.ico b/static/favicon.ico new file mode 100644 index 0000000..81582e2 Binary files /dev/null and b/static/favicon.ico differ diff --git a/static/favicon.png b/static/favicon.png new file mode 100644 index 0000000..b77a959 Binary files /dev/null and b/static/favicon.png differ diff --git a/static/js/blog.js b/static/js/blog.js new file mode 100644 index 0000000..a49a72f --- /dev/null +++ b/static/js/blog.js @@ -0,0 +1,28 @@ +'use strict'; + +/* globals window */ + +((window) => { + + const internals = { + kEntryPoint: '.event-details', + + // Application entry point, for now just band to keyboard + + main() { + + window.document.addEventListener('keydown', internals._onKeyDown); + }, + + // Handles key events to point to the correct blog post. + + _onKeyDown(event) { + + if (['1','2','3'].indexOf(event.key) > -1) { + window.location.hash = event.key; + } + } + }; + + window.addEventListener('load', internals.main); +})(window); diff --git a/templates/index.html b/templates/index.html index 858396b..e741c68 100644 --- a/templates/index.html +++ b/templates/index.html @@ -6,6 +6,8 @@ blog 🍕 + + -- cgit