summaryrefslogtreecommitdiff
path: root/README.md
blob: 47137302da81ce2f8dc010920da3dd8d56336b32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# blog

Blog at unlimited.pizza -> Only 

## How to install

`npm install -g .` will expose the `blog` binary to your CLI.

## How to add a new entry

Create a directory with a `.md` markdown file, and an `/assets`
directory with anything you want in there. This can be in any directory.

```
.
└── this-is-an-example-post
    ├── assets
    │   └── example.png
    └── this-is-an-example-post.md
```

You can add this to the blog using the following command, it will shift
all entries and remove the oldest one if limit of posts is reached
(defualts to 3):

`blog --add path/to/blog_post`

These commands will regenerate the static files. At that point you can
preview your blog by serving the files on the `static` directory. 

If you need to make corrections use:

`blog --update path/to/blog_post`

This will replace the latest with the contents of the `path` without
shifting the existing entries.

`blog --publish`

Will publish the blog.

## How to publish

At the moment, the app does not include any publishers. [surge][surge] is an easy
way to do it, just point it to your static directory.


[surge]: https://surge.sh