Skip to content

whalelogic/marknote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown Web Server

This web server serves all markdown files in the repository in a clean, browsable format.

Why?

  • 🗂️ Easily view and navigate your notes without leaving the browser
  • 🚀 Fast, lightweight and minimal with no external dependencies. Perfect for extending with your own features.
  • 📁 Automatically organizes files by directory structure
  • 🔍 Search and filter capabilities (coming soon!)
  • Secure and private - runs locally on your machine
  • Just drop your .md files or entire folders in the /static/ folder and they will be available on the web interface in an organized way.

Features

  • 📄 Automatically discovers all .md files in the repository
  • 🎨 Clean, responsive UI with syntax highlighting
  • 📂 Organized by directory/category
  • 🔍 Easy navigation between files
  • 📱 Mobile-friendly design

Usage

From the repository root, run:

go run web/markdown-server.go

Then open your browser to: http://localhost:8080 image

Structure

  • markdown-server.go - Main server application
  • templates/ - HTML templates
    • index.html - Homepage listing all markdown files
    • view.html - Individual markdown file viewer
  • static/ - Static assets
    • your_files/ - All your notes converted to HTML : )
    • style.css - Stylesheet for the entire site

Dependencies

  • github.com/gomarkdown/markdown - Markdown to HTML conversion

The server uses only Go standard library packages (net/http, html/template) plus the markdown parser.

About

A fast and organized way to view your markdown rendered in HTML.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors