28 lines
1.6 KiB
Markdown
28 lines
1.6 KiB
Markdown
|
# ngx-retroblog
|
||
|
|
|
||
|
|
Alternate version of [ngx-dumblog](https://github.com/pedroCX486/ngx-dumblog), with Markdown support! With customization on the settings.json file, lightweight size (no bootstrap!) and more. The editor you need to compile from the [showdown-canvas](https://github.com/pedroCX486/showdown-canvas) project.
|
||
|
|
|
||
|
|
## Customizations
|
||
|
|
|
||
|
|
On the settings.json file you'll find options to customize your blog title, avatar, bio, social networks (leave the fields empty, don't delete them if you don't want them showing up!) and ability to select how many posts will be shown on the home page.
|
||
|
|
|
||
|
|
## Creating and editing posts
|
||
|
|
|
||
|
|
You have to compile and host a build of the [showdown-canvas](https://tildegit.org/pedrocx486/showdown-canvas) editor. From there you can create and edit posts. To have those posts reflect on your blog, you need to place the files it generates in the assets/posts folder of your install.
|
||
|
|
|
||
|
|
## Running locally
|
||
|
|
|
||
|
|
First run `npm install` then run `npm start` and it should open automatically on `http://localhost:4200/`.
|
||
|
|
|
||
|
|
## Build
|
||
|
|
|
||
|
|
Run `npm run build` to build it. You can also run `custom-build.bat` to build it and then have the index.html title changed after build. But **first** change the variable BLOGNAME inside the .bat file! I intend to add a tool in the future capable of reading the name from the settings.json and then updating the index.html after the build, instead of keeping this .bat file.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Just do a pull request. :-)
|
||
|
|
|
||
|
|
## Why?
|
||
|
|
|
||
|
|
Because I always thought Jekyll to be too convoluted and I wanted something dumb and simple. The code isn't an example of awesomeness but it does the job and pretty well at that.
|