mallvielfrass / md-blog

Simple personal blog/wiki engine based on markdown articles

md-blog

Overview

md-blog is a simple personal blog/wiki engine with markdown support.

Here you can store, organize and collaborate on information in a way that suits you best. Create, explore and share your knowledge with ease!

• Quickly access and edit your notes using the intuitive web-based interface
• Customize your pages using Markdown markup language
• Collaborate with friends and colleagues by inviting them to view or edit specific pages
• Write your thoughts and share them with everyone

Config file

• Create a config file .env with the following content:

DB_TYPE=cloverdb # todo add mongodb
PATH=./db # for cloverdb
HOST=localhost # for mongodb or postgresql
PORT=5432 # for mongodb or postgresql
DB_NAME=md_blog  # for mongodb or postgresql

Usage

Just clone this repo and run the file /cmd/main.go.

git clone https://github.com/lemjoe/md-blog.git
cd md-blog
go mod tidy
go run cmd/main.go

Then type localhost:4007 in your browser's address bar.

Roadmap to beta:

Milestone	Ready?
Translation en-ru	❌
Integration with database	✔️
Authentication	❌
Working editor with preview	✔️
Code refactoring	❌
Docker-ready	❌

Roadmap to refactor:

Tasks	Ready?
init project structure	✔️
add interfaces for Tables db	✔️
implement db methods	✔️
add interfaces for services	✔️
implement services methods	✔️
porting handlers	❌
add fs services	✔️