search

AranScope / gityll-blog

My personal site, using Gityll.
1 stars 0 forks source link

Gityll Basics #3

Open AranScope opened 7 years ago

AranScope commented 7 years ago

Gityll is a customizable site generator using Github issues as a CMS and Express as a backend web server.

Setup Guide

To run Gityll I suggest using a VPS from DigitalOcean or AWS EC2.

  1. git clone https://github.com/aranscope/gityll
  2. cd gityll/templates/
  3. customize the contents template and post template to your hearts desire
  4. cd ..
  5. node gityll.js [port] [git repo url]

Running Gityll will throw dependency errors, in the meantime before this is properly packages, you can manually run npm install [dependency] or npm install [dependency] -g to install these dependencies locally or globally.

Tags

Posts

These tags can be added anywhere in the template.html file.

title - the title of the post
body - the html content of the post
author - the author's name (assignee of the issue)
author_url - the author's github url
author_icon_url - the authors github profile icon
time - the time the post was last modified
tags - the tags for the post

Contents

These tags can be added anywhere in the contents.html file.

body - links to all of the posts, dependent on theme
kiswa commented 7 years ago

Does it use the comments from the issue too?

EDIT: No. But that would be interesting.

AranScope commented 7 years ago

I'm deciding whether to use this for a 'live blogging' system, or for a public comments system, open to ideas.