Skip to content

sandrolain/markreader

Repository files navigation

MarkReader: Structured markdown viewer

MarkReader is a markdown file viewer based on web technologies. It allows you to browse hierarchical file structures and to view documentation written in markdown via browser without the need to a prior conversion to html format. Navigation and conversion is performed dynamically by the client application.

ToDo

  • Documentation and examples
  • Preload message and styles
  • Error message and styles
  • Config: parameter to hide main navigation
  • Config: parameter to hide headers navigation
  • Config: parameter to hide credits
  • Shortcodes-like syntax plugin with optional definition file
  • Dark Theme
  • Embedded markdown editor / preview

About

MarkReader: Markdown reader and docs viewer

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published