added readme for those that come from the website link
This commit is contained in:
parent
7dcfceeafe
commit
864681c108
27
README.md
Normal file
27
README.md
Normal file
@ -0,0 +1,27 @@
|
||||
# Hello
|
||||
|
||||
This is the source code for the website all packaged here.
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
Images used for the site go here
|
Loading…
Reference in New Issue
Block a user