deardesi.js/README.md

77 lines
1.4 KiB
Markdown
Raw Normal View History

2015-01-13 10:37:21 +00:00
Dear Desi
=========
2015-01-11 04:58:49 +00:00
A nice, friendly tool to help you get set up and start blogging with Desirae
2015-01-11 04:59:40 +00:00
Front-end written in AngularJS, back-end in Node.js
2015-01-13 10:37:21 +00:00
Install and Usage
=================
If you're on OS X or Linux, it's as easy as pie to install and use Desirae.
First install io.js (or node.js), if you haven't already.
2015-01-13 10:37:21 +00:00
```bash
# io.js
2015-01-17 23:15:04 +00:00
echo "v1.0.1" > /tmp/IOJS_VER
curl -fsSL bit.ly/easy-install-iojs | bash
# node.js
2015-01-13 10:37:21 +00:00
echo "v0.11.14" > /tmp/NODE_VER
curl -fsSL bit.ly/easy-install-node | bash
```
Then install desi
2015-01-13 10:37:21 +00:00
```bash
npm install -g desi
2015-01-13 10:37:21 +00:00
```
And create a copy of the desirae-seed
```
git clone git@github.com:DearDesi/desirae-blog-template.git ~/my-desirae-blog
pushd ~/my-desirae-blog
git submodule init
git submodule update
```
And now fire up Dear Desi to get started
```
2015-01-16 00:17:23 +00:00
desi serve -d ~/my-desirae-blog
2015-01-13 10:37:21 +00:00
```
Now open up your evergreen browser to <http://local.dear.desi:65080>
Commandline
===========
Once you've done the initial setup in the browser, you can run `desi` from the commandline
2015-01-13 10:37:21 +00:00
2015-01-16 00:17:23 +00:00
**NOTE:** You can omit the `-d` if you are already in your blog directory.
Build Production Site
---------------------
You must set `base_path` and `base_url` in `site.yml` before attempting to build.
2015-01-13 10:37:21 +00:00
```
2015-01-16 00:17:23 +00:00
desi build -d ~/my-desirae-blog
2015-01-13 10:37:21 +00:00
```
Outputs to `~/my-desirae-blog/compiled`
2015-01-13 10:37:21 +00:00
Create a new Post
-----------------
```
2015-01-16 00:17:23 +00:00
desi post "My First Post" -d ~/my-desirae-blog
2015-01-13 10:37:21 +00:00
```
Outputs to `~/my-desirae-blog/posts/my-first-post.md`