https://github.com/zjzmisaka/mdocreader

Reading Markdown documents (e.g., GitHub wiki)
https://github.com/zjzmisaka/mdocreader

github-wiki markdown reader viewer

Last synced: 6 months ago
JSON representation

Reading Markdown documents (e.g., GitHub wiki)

• Host: GitHub
• URL: https://github.com/zjzmisaka/mdocreader
• Owner: ZjzMisaka
• License: wtfpl
• Created: 2025-04-02T17:59:17.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-04-09T19:12:59.000Z (6 months ago)
• Last Synced: 2025-04-09T20:24:44.041Z (6 months ago)
• Topics: github-wiki, markdown, reader, viewer
• Language: C#
• Homepage:
• Size: 93.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# MDocReader

Reading Markdown documents (e.g., GitHub wiki)  

The initial purpose of this project is to help users who find it inconvenient to browse Github wikis by allowing them to view markdown-format wiki documents locally.  

### Usage

Extract the files from the compressed package into the wiki folder (at the same level as the markdown files), and then open MDocReader.exe.  

### Gif

![Gif](https://github.com/user-attachments/assets/80a41a00-0d02-4c18-91cd-22f24dec9373)

### Features

- History: You can review your browsing history.

- File list: You can browse the complete list of files.

- Themes: The software offers two themes: Light and Dark.

- Persistence: You can persist Markdown wiki documents into an executable file, allowing you to browse the wiki documents anywhere by simply copying the exe file.

### Shortcuts

- Ctrl + Left to back.

- Ctrl + Right to forward.

- Ctrl + B to view file list.

- Press Ctrl + T to switch themes.

- Press Ctrl + Shift + S to persist the document.