New project: The "English" editor for GitHub

Open
#48 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
html, markdown
Domain
frontend, web-dev

Research direction

Start with the issue's references to Medium-Editor, Markdown conversion, and saving text locally between edits. Clarify the editor's scope and persistence behavior; done would mean a defined way to edit, initialize from, save, and push GitHub README Markdown.

Written by the indexing model from the issue text.

Description

From today's Scripting News:

Speaking of convolution. I'm trying out the idea of a wizzy editor for GitHub readmes. You get a simple editor, based on Medium-Editor, so you get simple styling, lists, heads. And I found a plug-in that generates Markdown code. So what I push up to GitHub is Markdown, which is the only style that GH renders as HTML as far as I know. It works. Now the question is how to save the text locally between edits. Ideally it would be in Markdown, but the plug-in can't turn Markdown into HTML to initialize the editor. There was a thread on the repo for the project where people asked for this but it appears not to have happened. I tried the hack. Use another MD processor to do the initial conversion, and go from there. Hey Markdown is enough of a standard that it works. What a hack. I love it. PS: I started a thread on my repo for this project if you have questions or opinions.

This is the thread. Ask or suggest away. ;-)

Dominant language
HTML
Stars
134
Forks
10
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from scripting/Scripting-News

All issues in scripting/Scripting-News

Similar issues

More Web Dev issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.