life-itself/web3

[inbox] Improvements to content presentation

Open

#70 opened on Mar 17, 2022

View on GitHub
 (1 comment) (0 reactions) (2 assignees)HTML (1,644 stars) (218 forks)batch import
good first issue

Description

Context: we are using a remark-based pipeline for converting markdown => html (all inside of a nextjs react app).

We are also tending to use obsidian to edit the content in the wiki (though you can use any markdown editor you like!).

Writing / Markdown

  • #99
  • Display videos nicely #88
  • Support proper obsidian wiki link syntaxes - #96
  • Citation rendering #91 ie. [@bernanke_essays_2004] work see eg. https://web3.lifeitself.us/concepts/gold-standard
  • Support additional obsidian markdown e.g.
    • GFM: table and task list, footnotes (?) 
      | Markdown **table** |
**- [x] Task list**
    • #Tags
    • $$LaTeX math$$

Big

  • #127
  • #128
  • #82
  • #129

Minor nice to have

WONTFIX

  • 🔽 link to good first issue stuff from contribute section WONTFIX. People who know what they are doing will work this out (?)

Contributor guide

Tech stack
javascriptreactnextjshtml
Domain
frontenddocumentation
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.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
React basicsNext.js projectsMarkdown parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
First, understand the existing remark pipeline in the Next.js app by exploring the codebase for markdown processing. Examine linked issues #91, #127, #128, #129 for specific feature requirements. Check if any work has been done on these subtasks by reviewing commits and branches. For implementing a new feature like GFM table support, look into remark plugins such as `remark gfm`. Consult maintainers for guidance on scope and acceptance criteria.