Oxbian/BlogGenerator
1
0
Fork 0
Code Issues Pull Requests Activity

Credits to ploum & explanation on how to use this project

Browse Source
This commit is contained in:
Oxbian 2023-06-24 22:37:15 +02:00
parent b7ea89bc36
commit da3a8b7408
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -3,7 +3,7 @@
This repo contains a python script that can create a blog from a list of markdown files. You just need markdown files, a page template, an index page template, an atom feed template and an atom post template. This repo contains a python script that can create a blog from a list of markdown files. You just need markdown files, a page template, an index page template, an atom feed template and an atom post template.
If you need some example check my [blog source code](https://git.arka.rocks/Oxbian/ArkaBlog). If you need some example check my [blog source code](https://git.arka.rocks/Oxbian/ArkaBlog).
## How to use it ## How to setup
First you will need some compatible written markdown files, the supported markdown is listed below. First you will need some compatible written markdown files, the supported markdown is listed below.
After that, you will need to setup the .env file with your configuration and create template for the page, index, Atom Feed & Atom post. After that, you will need to setup the .env file with your configuration and create template for the page, index, Atom Feed & Atom post.
@ -31,6 +31,11 @@ Don't create / use virtual env, just install the requirements on your global pyt
pip intall -r requirements.txt pip intall -r requirements.txt
``` ```
## How to use it
Now that everything is configured, you can just run `python3 generator.py` and the page will be generated.
**Be careful if there is no metadata in your markdown file the page will not be added into the index page.**
## Supported markdown ## Supported markdown
Here is listed the supported markdown for this blog generator : Here is listed the supported markdown for this blog generator :
@ -80,3 +85,8 @@ If you have any troube you can contact me by email, matrix, or open an issue. If
## License ## License
This project is under the GPLV3 license. You can use, modify, as long as the copy is opensource under the GPLV3 too. This project is under the GPLV3 license. You can use, modify, as long as the copy is opensource under the GPLV3 too.
## Credits
This project was inspired by the [blog generator](https://git.sr.ht/~lioploum/ploum.net) made by [Ploum](https://ploum.net), thanks to him for his work.