showdownjs/showdown

Load a external Markdown File.

Open

#682 opened on Apr 14, 2019

View on GitHub
 (4 comments) (0 reactions) (1 assignee)JavaScript (13,700 stars) (1,640 forks)batch import
help wanted

Description

Well, I think the title is self explanatory ^^\

I have a Markdown File named "article.md", and want use this file inside of my html.

# Hello World!
Lorem Ipsum
- Lorem Ipsum

<h1>Hello World!</h1>
<p>Lorem Ipsum</p>
<ul>
    <li>Lorem Ipsum</li>
</ul>

Contributor guide

Tech stack
javascript
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic JavaScriptUnderstanding of MarkdownFile I/O concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the current converter API in `src/showdown.js` to determine where to add a file loading function. Consider whether the library should support Node.js `fs` module or browser `fetch`. Look at existing methods like `makeHtml` and `makeMarkdown` for consistency. Provide a sample implementation in a pull request that accepts a file path or URL and returns the converted HTML.
Load a external Markdown File. · showdownjs/showdown#682 | Good First Issue