Giter Club home page Giter Club logo

markdownpreview's Introduction

About

Two programs that allow users to preview the formatting of a markdown file.

  • CLI contains a command line program that parses and serves the markdown file in the brower.
  • GUI contains a program that allows the user to write/ edit markdown files and view the format changes in real time. NOTE: the program displays the preview in plain text, since I haven't figured out how to webview working in Fyne.

Warning

The cli program will try to gracefully shutdown when you press Ctrl+C. If you close the program without pressing Ctrl+C, the port will be occupied and you will need to either use a different port or kill the process.

Why?

I am bad at remembering the syntax of markdown. This program allows me to preview the file and see how it looks before I commit it.

Usage

    $ cd CLI/
    $ go run Preview.go -file=<file> -port=<port>

or

    $ cd GUI/
    $ go run PreviewGUI.go

Dependencies

TODOs

  • Add a flag to specify the file
  • Add a flag to specify the port
  • Create a markdown file that contains all the markdown syntax, to test the program
  • Create my own markdown parser and web framework instead of using Blackfriday and Gin (Maybe I will do this in the future)
  • A GUI that allows you to edit the markdown file and preview it in real time
  • Add support for copying and pasting in the GUI

markdownpreview's People

Contributors

ecampo12 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.