dennisdoomen/blog

Checklist: Markdown Conversion

Open

#28 opened on Mar 22, 2018

View on GitHub
 (4 comments) (0 reactions) (0 assignees)HTML (11 forks)github user discovery
help wanted

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

(spawned via discussion on #23)

Due to the conversion from Blogger, a lot of the posts are still in HTML format, which can cause problems:

  • The formatting will be off
  • They show as one long string of HTML
  • Other considerations (images, code samples, etc.) have not been covered.

So we'll try to knock these out one at a time in the order of priority, since the site is live.

What we need to do for each post

When converting a post, you'll need to:

  • Rename the post file from .html to .md
  • HTML formatting to markdown formatting
  • Save images to assets/images/posts and reference them from there
  • Mark all code samples in markdown and indicate the language
  • Revise to clean up in another ways as necessary
  • Use {{ site.baseurl }}{% post_url 2010-07-21-name-of-post %} for links between posts
  • Use ![My helpful screenshot]({{ "/assets/screenshot.jpg" | absolute_url }}) for linking to images.

We prefer many small PRs here, so tackle one or two posts at a time, and then check that post off on the list.

Prioritized List of Page Conversions

  • TBD

Contributor guide

Research direction
Convert an HTML blog post to Markdown. Rename file from .html to .md, change HTML tags to Markdown syntax, save images to assets/images/posts, mark code samples with language, and ensure internal links use Liquid tags.
Tech stack
html
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80