core

Documentation

Index

• func FlagCombinationSensible()
• func LivePreview(fileName string)
• func Run(fileName string)
• func WatchForChanges(fileName string, executor func(string))

Functions

func FlagCombinationSensible

func FlagCombinationSensible()

alerts the user if a flag depends on a different flag to have an effect

func LivePreview

func LivePreview(fileName string)

live preview allows the user to edit the markdown source and view the effects of the modification in the browser via reload on change

1. compiles the source (server)

2. serves the html output (server)

3. injects a websocket script into the html (server)

4. starts a websocket connection (server)

5. opens a tab in the default browser pointing to the html (server)

6. establishes a websocket connection (client)

7. waits for changes, notifys the client via websocket when the source changes (server)

8. reloads if websocket event go (client)

func Run

func Run(fileName string)

func WatchForChanges

func WatchForChanges(fileName string, executor func(string))

watches for changes in a file, recompiles the file if a change occurs, can be exited via <C-c>