md-blog

module
v0.0.0-...-08e0fe9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2023 License: BSD-3-Clause

README

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
DB_PATH=./db # for cloverdb
DB_HOST=localhost # for mongodb or postgresql
DB_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
Add PostgreSQL
Dark/light theme

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL