jamesplease / jamesplease/gistbook
Add docs for text area
Open
Nobody has claimed this yet.
enhancement
ux
- Dominant language
- JavaScript
- Stars
- 88
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
When you enter text edit mode, there should be a little message that links you off to a docs page. That page would have information that explains how both Github flavored markdown and Mathjax are supported, in addition to what the delimiters for math & inline math are.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the text edit mode UI and the project's documentation or page structure. Add the edit-mode link and a page explaining GitHub Flavored Markdown, MathJax, and the delimiters for math and inline math; done when the message and documentation are available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100