sc0ttj / mdsh

A simple static site generator, using Markdown and Bash
https://sc0ttj.github.io/mdsh/
10 stars 0 forks source link

Rename project/repo as 'blog' #2

Closed sc0ttj closed 5 years ago

sc0ttj commented 5 years ago

The GitHub Pages URLs that sites are often deployed to are http://<user>.github.io/<repo>/

So if we want http://user.github.io/blog/, then this repo/project needs to be called blog or the user must use git clone http://github.io/sc0ttj/mdsh/ blog.

(there are other solutions, but i don't like them)

NOTE:

If the repo itself is called user.github.io, then the URL will be http://<user>.github.io/ (no subdir at the end). In this case, the $blog_url variable in .site_config can simply be set to nothing (blog_url='')

sc0ttj commented 5 years ago

Dont bother ... just document installation clearly (repo name is sub dir, unless repo name is user.github.io