https://github.com/karapetianash/markdown-preview

https://github.com/karapetianash/markdown-preview

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/karapetianash/markdown-preview
• Owner: karapetianash
• Created: 2024-03-21T08:30:27.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-04-01T20:20:16.000Z (9 months ago)
• Last Synced: 2024-04-02T20:55:21.531Z (9 months ago)
• Language: Go
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Description

This CLI tool performs four main steps:

1. Reads the contents of the input Markdown file;

2. Uses some Go external libraries to parse Markdown and generate a valid

   HTML block;

3. Wraps the results with an HTML header and footer;

4. Saves the buffer to an HTML file that you can view in a browser.

## Supported flags

- `-file `\

Markdown file to be previewed.

- `-s`\

Skip auto-preview.

## Usage

To build the app, run the following command in the root folder:

```

> go build .

```

Above command will generate `mdp` file. This name is defined in the `go.mod` file, and it will be the initialized module name.

After that you can run the program using the cmd and pass the file:

```

> .\todo-cli.exe -file File Name

```