shockrah/blog
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

modern readme

Browse Source
This commit is contained in:
Medium Fries 2018-12-23 00:15:18 -08:00
parent 79d6a3ab4e
commit e6b1427258
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -6,22 +6,24 @@ Below is a description of what each directory contains and why.
## ~/
* `index.md` - markdown of the main page, is rendered using `make.sh` into an html file which is then used on neocities
* `index.html` - the main page where most links can be found in the site
* `notes.md` - random notes that I use to remind myself of how things work on occasion.
* `make.sh` - build file for basically everything
## /markdown
* `build.sh` - build script that basically does what `make.sh` but in a lazy(stupid) as hell way
## ./markdown
Container for all/post articles and/or posts to the site, including but not limited to the homepage, site philosophy post and others. These are then rendered into actual html files using the `make.sh` file.
## /post
Stylesheets for the actual posts as well as the previously mentioned html render files which pandoc produces.
## /img
## ./img
Images used for the site go here
## ./fonts
Fonts that are really cool
## ./_site
Though this directory doesn't show up on in the repository it's where the public files go once they are built and ready for the actualy website