hackmdio/codimd

[Feature Request] API to download HTML

Open

#515 opened on Jul 17, 2017

View on GitHub
 (6 comments) (5 reactions) (0 assignees)JavaScript (8,949 stars) (1,038 forks)batch import
Hacktoberfestfeaturegood first issue

Description

I'm missing a way to download the HTML using a script or something else. I assume that the HTML that will be downloaded when clicking on the "Download" > HTML button is generated by the front end javascript.

Our use case: We write a protocol for our meetings in HackMD and want to mail this protocol to our mailing list. For better readability we want to append the HTML as MIME part.

Contributor guide

Tech stack
javascriptnodejsexpress
Domain
backendapi
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 Node.jsExpress routing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing frontend code that generates HTML for download (likely in client side JavaScript). Identify the data flow and then create a new API endpoint (e.g., GET /api/notes/:id/html) that returns the rendered HTML. Check if any existing routes or utilities can be reused. The issue lacks specifics on authentication, so consider whether the endpoint should require auth.