{"repo":"uxiew/epub2MD","free":true,"listed":false,"github":"https://github.com/uxiew/epub2MD","clone":"git clone https://github.com/uxiew/epub2MD.git","description":"convert epub file to markdown files","language":"TypeScript","stars":324,"topics":["epub","markdown","epub-to-markdown","converter","epub2md"],"license":"MIT","category":"media-processing","readme_excerpt":"📖 epub2md Even though the package is primarily intended for CLI is to convert EPUB to Markdown, but it can be used programmatically. 主要的目标是转换 epub 为 多个 markdown 文件，或者合并为 单个 markdown 文件，可以处理其中的远程图片资源；当然了也可以当做 epub 的解析器库使用. Main Functions - Convert EPUB to Markdown : By default, convert and output numbered markdown files in sequence. - Autocorrection : Have option to Handle spaces and punctuation between Chinese and English as You Need. - Merge Chapters : Optionally merge all markdown files into a single Markdown file, Support link jumping. - Image Processing : - Retain the original online image links. - Download and localize online images (save remote images locally). - View Information : Easy to View the basic information, structure, and chapters of the EPUB. - Extraction Function : Just extract the useful contents of the EPUB file. Global Install for CLI Development Install CLI Usage parseEpub(target: string buffer, options ?: ParserOptions): EpubObject target type: string or buffer It can be the path to the file or file's binary string or buffer options: ParserOptions - type ?: 'binaryString' 'path' 'buffer' It forces the parser to treat supplied target as the defined type, if not defined the parser itself will decide how to treat the file(useful when you are not sure if the path is valid). - expand ?: boolean - convertToMarkdown ?: (htmlstr: string) = string use custom convert function, you can use turndown or node-html-markdown.etc. EpubObject The return value is an obje","default_branch":null,"files":null,"tree":[],"storefront":"/r/uxiew","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/uxiew/epub2MD/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}