From ce34b5fd62456405d2cddcb5a67a569c0975c8f6 Mon Sep 17 00:00:00 2001 From: Stephen Cochrane Date: Sun, 3 May 2020 20:58:27 +0200 Subject: [PATCH] Updated readme --- README.md | 53 +++++++++++++++++++++++++++++++++++++---- blogs/preamble/end.html | 2 +- 2 files changed, 49 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 47d0467..393d0f8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,51 @@ # yggpi This is my website root, I plan on improving it over time -## Details -The purpose of this repo is to 'act' as the root of my website, allowing for -easier transfer to different domains, and editing the website, as wherever the -website is hosted, the website will display what ever is on master, with -daily updates (this will be handled by a script. +## Static Blog +The goal of this website is to serve 'static' content that gets updated +through scripts, this is to reduce bloat, and to ensure a fast website. +To create the 'full' website, it is important to first run, +```` +make blog +```` +as this will create blog posts from the files found in `blogs/RawBlogs`, and +and setup all the links and stuff for them, these blog files are written +with a custom markup lanuage with very simple markups, Currently there are the +following: + +--- + +(1) +```` +[ +Normal Text Goes Here. +] +```` + +--- + +(2) +```` +( +Block Text Goes here. +) +```` + +--- + +(1) Will generate: +```` +Normal Text Goes Here. +```` + +(2) Will generate: +```` ++--------------------------+ +| | +| Block Text Goes Here | +| | ++--------------------------+ +```` + +## Reason for C +Its fast. Aint no body got time for bloated stuff. diff --git a/blogs/preamble/end.html b/blogs/preamble/end.html index b9f882b..ad27535 100644 --- a/blogs/preamble/end.html +++ b/blogs/preamble/end.html @@ -1,4 +1,4 @@ -View page source +View page source