aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e2f42c63b574a21089a72151ee897a83a5cc50c0 (plain) (blame)
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
# seen flask edition

*A simple blog generator*

### Advantages over seen v0.1

- Rewritten from scratch ;

- Generates webpages on-the-fly: No need to run a script everytime 
a new article is added ;

- Unified config file ;

- Unified HTML5 template file ;

- Better RSS Feed support ;

- The code is better formatted (Less than 80 chars on every line) ;

- Licensed under the GNU AGPLv3 License.

### Disadvantages over seen v0.1

- A little bigger (seen v0.1 is 88 lines long, while seen flask edition 
is 112 lines long) ;

- Has more dependencies.

### How to use

First, install `flask` and `python3-markdown`.

Put your markdown files on `articles/<name of file>.md` 
(create the directory if it doesn't exist).

You also need to add an entry in the `config.ini` file.

```
[Hello_World]
Title=Hello World!
Description=Welcome to my blog!
Date=01 Oct 2022
```

Take a look at the `config.ini` file and modify it to your liking. 
Almost every option has a comment explaining its purpose.

See 
[Deploying to Production](https://flask.palletsprojects.com/en/2.2.x/deploying/)
for instructions on how to deploy Seen (or any other WSGI app).