~sky/blog

ref: 0ba7f5e73273f9d25194595176b69c3a4c55ebd4 blog/README.md -rw-r--r-- 1.4 KiB
0ba7f5e7sky Update README.md 2 years ago

#up-blog: A flexable, modular, ssg and template system.

#Dependencies:

  • nvim
  • scp (soon to be moved to rsync)
  • shell

#Installation:

I havn't gotten around to writing an install script, so the user is responsible for the following:

  • Cloning the repo
  • Editing everything under the 'templates' folder to reflect your title and domain names for your website
  • Editing the script to reflect your server address and the name of your blog
  • (Optional) moving the install script into your $path variable.
  • (Optional) putting your logo in the blog directory named 'logo.png'

#Usage:

#To upload existing files or update for changes

Execute:

	$ up-blog 

This will use the templates to update everything in the input folder

#To create a new post

Execute:

	$ up-blog 'article name'

This will create a new head file and html body file named 'article name', put them in input, open vim to edit them, and then run the update script.

#Back-End:

This script works by putting together a series of files which will make a single webpage. It takes the '.head' files and the '.html' files from 'input', combines them with templates from the 'templates' directory, and sends them to the 'output' directory. The script then uploads the files in the 'output' directory to the given hosting service. the 'output' directory. The script then uploads the files in the 'output' directory to the given hosting service.