Skip to content
NodeJS CLI static blog generator that uses Jekyll-compatible markdown format and features convenient command line tools.‬
JavaScript HTML CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
dest
lib
partials
src
.gitignore
.init-gitignore
CHANGELOG.md
README.md
package-lock.json
package.json
quest-log-config.json

README.md

Quest Log

Quest Log is a simple NodeJS CLI + Markdown static blog engine that uses standard Jekyll Markdown format, Handlebars for templating, and features convenient command line tools.

Availble on NPM: Quest Log

This repo is on: GitLab | GitHub

Quick Start Guide

  • Create a folder for your blog to live in and navigate inside the folder in your terminal.
    Example:
mkdir chilaquiles-are-life-blog
cd chilaquiles-are-life-blog
  • Run this command to install the Quest Log npm module:
npm install quest-log
  • Install Quest Log's folder structure into your project:
npx quest-log-init
  • From here you can generate a post using the npx quest-log-post command:
npx quest-log-post "Chilaquiles are a journey for the soul"

where everything after npx quest-log-post is the title of your new post(in quotes!).

Now you you should see the path of your new post's markdown file in your terminal, ex:

New post markdown file created in: ./src/posts/2019/06/2019-06-09-16.12.27-chilaquiles-are-a-journey-for-the-soul.markdown
  • Now you can open that file in the text editor of your choice and edit the post's content to wahtever you want to post about!
    But before we get posting too much, let's talk about how to view your Quest Log site locally on your computer.

  • Now that we have a post markdown file created you will need to run Quest Log's build command to generate the static html files you can view in a browser.

    You do this with

     npx quest-log-build

    The files will magically appear in the ./dest folder.

To preview it

This part depends a bit on how you want to do things, if you already have a way you like to use to serve static html files locally you can do that. But you can't just open ./dest/index.html because there wll be path issues and your images and other things might wonk out on you.

Even though this is a Node project there is a really simple way to serve a static site locally using Python called SimpleHTTPServer and it is pre-installed on macOS and Ubuntu. Open a new tab in your terminal and run the command (from inside the ./dest folder):

cd dest
python -m SimpleHTTPServer 8000

Getting your new Quest Log site on the web

You need to serve the contents of the ./dest folder. Be sure:

  • to include all the files in that folder
  • the index.html file exists and is in the room of the folder you serve

I will provide some tips on doing this in a later patch.

Changing things and making it your own

Make changes in the ./quest-log-config.json file to make your Quest Log site your own.

title and subtitle are used in both metadata and shown on the site itself. description is your search engine description, and 'google-analytics-id' is optional

"title": "Quest Log",
"subtitle": "NodeJS CLI + Markdown static blog engine",
"description": "Quest Log is a NodeJS CLI + Markdown static blog engine that uses standard Jekyll Markdown format, Handlebars for templating, and features convenient command line tools.‬",
"google-analytics-id": "UA-XXXXXX-XX",

How to add additional pages / links to the nav

Pages example ./quest-log-config.json has a pages area, you can add additional pages like this: Note: One page must have the fileName index.html, this is the first page when people visit your site.

"pages":[
  {
    "name": "Home",
    "file": "index.html"
  },
  {
    "name": "Portfolio",
    "file": "portfolio.html"
  },
  {
    "name": "Blog",
    "file": "blog.html"
  },
  {
    "name": "Contact",
    "file": "contact.html"
  }
],

Each page will require a corresponding Handlebars file of the same name in the ./src/pages/ folder. For example: if you want a portfolio.html page you need to add a portfolio.hbs file in ./src/pages/.

Links can be added using the same method shown above, but you will need to add the "linkOnly": true property. example:

"pages":[
  {
    "name": "Blog",
    "file": "index.html"
  },
  {
    "name": "Games",
    "file": "http://twoscoopgames.com/",
    "linkOnly": true
  },
],

In the example above, "Blog" will be the homepage of the QAuest Log site, and "Games" will link directly to the website specified.


Import from other blog platforms

Current working importers:

  • Tumblr

In the works:

  • Wordpress

TUmblr importer

To import all posts and images from your existing Tumblr blog, navigate to the root of your blog in the terminal and use the command: npx quest-log-import-tumblr https://yourblogname.tumblr.com (be sure to use the full url inclusing 'https://' and be sure not to have a '/' at the end of the url)

Known Bugs

(Help appreciated!)
Check out the 'Bugs' column on the Quest Log Trello Board

Future improvements

(Help appreciated!)
Check out the Quest Log Trello Board

You can’t perform that action at this time.