issue2md

A CLI and web tool to convert GitHub issues, discussions, or pull requests into Markdown format.

中文文档

The majority of the content in this repository was generated by AI.

Command-line Mode

Install issue2md CLI

$ go install github.com/bigwhite/issue2md/cmd/issue2md@latest

Convert an Issue/Discussion/Pull Request to Markdown

Usage: issue2md [flags] url [markdown-file]
Arguments:
  url            The URL of the GitHub issue, discussion, or pull request to convert.
  markdown-file  (optional) The output markdown file.
Flags:
  -enable-reactions
    	Include reactions in the output.
  -enable-user-links
    	Enable user profile links in the output.

Web Mode

Install and Run issue2md Web

Run issue2md web with docker(Recommended)

$docker run -d -p 8080:8080 bigwhite/issue2mdweb

Compile from source

$ git clone https://github.com/bigwhite/issue2md.git
$ make web
$ ./issue2mdweb
Server is running on http://0.0.0.0:8080

Convert an Item to Markdown

Open localhost:8080 in your browser:

Input the issue, discussion, or pull request URL you wish to convert and click the "Convert" button!