🇷🇺 Русский

⛺ My Markdown Site

100% client-side markdown CMS/viewer/editor written in Java Script. Current version is still experimental (but mostly works), but we're close to something useful. See demo site.

The purpose of it is to publish any set of markdown documents on any server in no time, be able to quickly edit them in place, and be able to easily use the same markdown files anywhere else.

Use cases

• Documentation
• Sites for limited term projects
• Sites for learning courses (when site is started with the course, than filled as the course go, and finally closed, converted to pdf and handed to students)
• Neocities
• Quick publication of notes from markdown note-taking apps like Obsidian or Joplin.

Comparison with alternative approaches

The main alternatives are either server-side Content Management System (CMS) or Static Site Generator (SSG) like Jekill. Others are online services, like Notion.

• SSG: resulting site may be static and more accessible (MMDS requires Java Script in browser), but you have to regenerate site after any edits or setup the automated workflow. Usually does not include markdown editor.
• CMS: more accessible site, usually includes editor and full-blown backend, but requires server setup and your need to perform additional task to get your text as separate files for use somewhere outside the CMS.
• Online services: a lot of useful functions, but your files are kept on they servers, when MMDS can work locally on your computer without Internet access. And it is not that easy to ban you from your own computer, you know.

Therefore, if you do not mind dependency on Java Script, MMDS do have some advantages here: ability to edit files in place, no special requirements on server software or source files and almost no setup.

Comparison with other projects of the same kind

• CMS.js: CMS, which works entirely in browser
• IMP!: my other project, single page CMS
• MDWiki: client-side wiki-like web app

🔧	CMS.js	MDWiki	MMDS	IMP!
Multi page site	yes	yes	yes	no
Site is viewable without JS	no	no	no	yes
URLs for pages	yes	yes	yes	inapplicable*
Editor	no	no	yes	yes
Can run without additional server setup	no	yes	yes	yes (edititng without server at all)
Automatic lists	yes	no	no	inapplicable*
Custom design	themes and templates	CSS	HTML and CSS	CSS
Custom functions	❓	Plugins	User scripts	Any scripts
Project status	mature	dead	just started	pretty mature

* IMP! is CMS/Editor/Viewer for single page.

Features

• Direct links to pages
• No restrictions on markdown content
• Renders HTML inside markdown
• Totally customizable design (html + css + JS API for custom scripts)
• Embedded markdown editor
• ...and, of course, you can use ANY markdown editor.
• Any server (no server setup required)

License

• MIT

Based on

• CodeJar
• Preact
• Markdown-it
• Prism
• ...