Skip to content

MarkdownNotes is a self hosted tool for organizing notes, files, lists, ideas by using markdown syntax.

Notifications You must be signed in to change notification settings

SSilence/markdownnotes

Repository files navigation

MarkdownNotes

MarkdownNotes is a self hosted tool for organizing notes, files, lists, ideas by using markdown syntax.

MarkdownNote Screenshot

requirements

  • PHP webspace (just 4 a small backend script, runs everywhere with PHP5+) or Docker
  • all modern browsers
  • mobile browsers

installation

  1. Download latest stable release ZIP file from https://github.com/SSilence/markdownnotes/releases and unzip
  2. Upload all files of this folder (IMPORTANT: also upload the invisible .htaccess files)
  3. Make the directories data/files and data/pages writeable
  4. If you are using MarkdownNotes on a subpath (e.g. http://example.com/markdownnotes) then add in .htaccess the line RewriteBase /markdownnotes/ and add in index.html <base href="/markdownnotes/">
  5. MarkdownNotes saves all data in files in the data dir. No database is necessary.

installation using docker

Start the MarkdownNotes docker image with:

docker run -v /yourpath:/var/www/html/data -p 80:80 ssilence/markdownnotes:latest

MarkdownNotes notes and files will be saved in your given path. Just replace /yourpath with target data dir on your system.

screenshots

MarkdownNotes Screenshot

MarkdownNotes Screenshot

credits

Copyright (c) 2021 Tobias Zeising, tobias.zeising@aditu.de
https://www.aditu.de
Licensed under the GPLv3 license

Special thanks to the great programmers of this libraries which will be used:

Icon Source (design by Freepik.com): https://creativenerds.co.uk/freebies/80-free-wildlife-icons-the-best-ever-animal-icon-set/