Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alfiana Sibuea committed Aug 14, 2014
1 parent d8c3e4c commit 77cc87f
Showing 1 changed file with 73 additions and 3 deletions.
76 changes: 73 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,74 @@
situs
=====
# Situs

Simple static site generator
Simple static site generator. Just it.

## Getting Started

Install Situs via npm.

```
~ $ npm install situs -g
```

Go to your static site directory.

```
~ $ cd your-directory
```

Then fire the development server! Situs will watch your directory. So if you make change one of your files, Situs will rebuild your static site automatically.

```
~/your-directory $ situs server
```


## Usage

```
$ situs build
# Build your source directory and place it to destination. (default: ./situs)
$ situs server
# Start development server, watch for changes and rebuild source automatically.
$ situs help
# Print Situs command usage.
$ situs -v
$ situs --version
# Print Situs version.
```

## Configuration

By default, Situs is able run without any configuration. But, if you want something advance, you can store the configuration on situs.json right on your source directory.

__Directory structure:__

```
/your-directory
- index.html
- page.html
- situs.json
```

__situs.json (default):__

```
{
"source': "./",
"destination": "./situs",
"ignore": [
"node_modules/**/*"
],
"port": 4000,
"global": {}
}
```

| Parameter | Value | Description |
|-----------|----------|-------------|
| `source` | _string_ | test |

To be continued..

0 comments on commit 77cc87f

Please sign in to comment.