summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordaniel-Jones <daniel@danieljon.es>2017-11-20 14:35:20 +1100
committerdaniel-Jones <daniel@danieljon.es>2017-11-20 14:35:20 +1100
commitdbc46786247ba1813e786568a674d6a5bd6a7b37 (patch)
tree6f4b40fbd8cc5612e9ba0c8d2a06c1bb2e8bb700 /README.md
parent5673735c626bfb28474ea4590f28e9f53f8513c8 (diff)
downloadwebsite-dbc46786247ba1813e786568a674d6a5bd6a7b37.tar.gz
website-dbc46786247ba1813e786568a674d6a5bd6a7b37.zip
forgot readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 6 insertions, 16 deletions
diff --git a/README.md b/README.md
index 1983380..29aa804 100644
--- a/README.md
+++ b/README.md
@@ -3,24 +3,14 @@ static site generator for my website/blog/portfolio at https://danieljon.es
# why?
My website previously relied heavily on php/databases and didn't render correctly inside my terminal web browser so I decided to take the static, html only route and created a static website generator.
# how do I use it?
-This script is really _really_ optimised for _my_ setup. to use it in its default state you need to do the following:
-
-modify template.txt to your liking, this is used on EVERY page
-
-create a directory named content
-
-create content/index.txt, this will hold your index.html content (just text and stuff)
-
-create content/portfolio.txt (or remove generateportfolio();)
-
-create directory content/blog
-
-create blog posts in content/blog, 1.txt is the OLDEST post.
-
-It's all just .txt files, you can add html/js to them.
+I've created the setup.sh script, it will generate everything you need to get a minimal website up with a few example blog posts, anime recommendation of k-on, nico as your waifu and two sample projects in your portfolio.
+'''
+Run ./setup.sh once.
+then everytime you update the site run:
+python3 generatesite.py && cp -r output/* /var/www #or where ever your root dir is
# settings.cfg?
-This file contains various settings you cna change including the number of blog posts per page, titles, content locations, blog directory etc. Play with these if you want.
+This file contains various settings you can change including the number of blog posts per page, titles, content locations, blog directory etc. Play with these if you want.
# .htaccess for blog?
I use the following as my .htaccees for /blog, it makes /blog go to blog/1, /1 translates to 1.html etc: