blob: 4c356bdc2bef45c3f50d955866ac9f8fe4053a49 (
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
# Kronikarz
Kronikarz is a file based system for managing blog posts. It's original purpose was to have an universal way for creating chronicles of scouting troops. But it's not only for scouts 😉.
## Getting started
Kronikarz has it's own rule for managing posts and at this point it is hard-coded. Required folder structure looks like this:
```
your_folder
└── {year}
└── {month}
└── {day}
└── {title}.md
```
Firstly install kronikarz with npm
```bash
npm install kronikarz
```
To use kronikarz you need to initialize it first with path to folder where all your posts are. If look at the example above it would be path to `your_folder`. You need to remember that when you run a script with npm current working directory is always root directory.
```js
import Kronikarz from "kronikarz";
const k = new Kronikarz("path/to/posts");
```
### Generating the api
For generating the json api run:
```js
k.generateApi(`./path`)
```
This will create all posts list in `./path/api/posts.json` and create json file
with content for every markdown file in
`./path/api/posts/{year}/{month}/{day}/{title}.json`.
Also you can specify categories (tags) like this in your post:
```md
---
title: Test
author: Tester
category:
- testing
---
```
And it will generate list of all posts in this category in
`./path/api/category/testing.json`
### Old functions
Now these function will return wrapper of `Post` object. If you want to get a
simple object like from json api run `post.toApi()`
```js
k.getPosts(); // returns array of all posts
let post = k.getPost("2019", "11", "20", "title"); // returns post from path `2019/11/20/title.md`
post.toApi();
```
|
