markdown-viewer

command module
v0.0.0-...-716adc8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 7, 2024 License: MIT Imports: 7 Imported by: 0

README

markdown-viewer

This is a simple Go application that serves a Markdown file as HTML using the goldmark package.

Installation

  1. Clone the repository:

    git clone https://github.com/mikelorant/markdown-viewer.git
    
  2. Navigate to the project directory:

    cd markdown-viewer
    

Usage

  1. Place your Markdown file in the project directory and rename it to content.md.

  2. Run the application:

    go run .
    
  3. Open your web browser and visit http://localhost:8080 to view the rendered Markdown file.

Dependencies

This project uses the following third-party package:

  • goldmark - A Markdown parser written in Go

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL