{"repo":"shfshanyue/markdown-read","free":true,"listed":false,"github":"https://github.com/shfshanyue/markdown-read","clone":"git clone https://github.com/shfshanyue/markdown-read.git","description":"Read markdown from URL","language":"TypeScript","stars":59,"topics":["markdown"],"license":null,"category":"productivity","readme_excerpt":"Markdown Read Convert any URL to Markdown. Try it online: HTML To Markdown Tech Stack + @mozilla/readability for read meaning html + turndown for html to markdown + jsdom for parse html Usage You will need Node.js installed on your system, then install it globally. Options - --header : Add custom headers to the request. This can be useful for setting user-agent strings or other HTTP headers required by the target website. Example: API Reference markdown(url: string, options?: MarkdownOptions): Promise Converts a web page to Markdown format. - url : The URL of the web page to convert - options : Optional settings for document retrieval and Markdown conversion - headers : Additional headers to include in the request - fetcher : Custom function to fetch the HTML content - All options from TurndownOptions are also supported Returns a Promise that resolves to a MarkdownContent object or null if conversion fails. MarkdownContent The MarkdownContent object extends ReadabilityContent and includes: - markdown : The converted Markdown content - length : The length of the Markdown content - url : The original URL of the web page turndown(html: string, options?: TurndownOptions): string Converts HTML content to Markdown. - html : The HTML string to convert - options : Optional settings for Turndown conversion. These options will override the default settings. Returns the Markdown representation of the input HTML. Default Options ', headingStyle: 'atx', bulletListMarker: '+' } javascript ","default_branch":null,"files":null,"tree":[],"storefront":"/r/shfshanyue","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/shfshanyue/markdown-read/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."}