Skip to content

Commit

Permalink
[vigetlabs#247] Update site README with more detailed instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
leobauza committed Mar 12, 2017
1 parent 7cedb67 commit 63980ef
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,31 @@
# Microcosm Site

The Microcosm website draws from `../docs` and `./src/content` to
build pages. It is published to Github Pages here:
- [Introduction](#introduction)
- [Setup](#setup)
- [Run Locally](#run-locally)
- [Publish](#publish)

## Introduction

The Microcosm website is built using markdown files, html templates, a stylesheet, and a few image assets. Here is a brief overview of everything you'll find in the `site` folder:

### public

The generated site will live here after running (we'll go over generating the site and serving the site locally in the next section.) With the exception of the `assets` folder you should never edit these files, they will be overwritten when regenerating the site and aren't in source control.

### scripts

The `Makefile` uses these files to generate the html files in the `public` folder, to serve the site locally, and to publish the site to Github pages.

### src



> Note that markdown files are in `../docs` (outside the site folder) and `./src/pages`.


It is published to Github Pages here:

http://code.viget.com/microcosm/

Expand Down

0 comments on commit 63980ef

Please sign in to comment.