michael / michael/svedit

Render text annotations in exported HTML

Open
#136 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
675
Forks
18
Avg merge
5h 11m
Merged PRs (30d)
1

Description

Svedid can provide a default annotation renderer that does <span data-type="strong">strong text</span> but also a custom renderer via html_exporters but we need to find a proper API for that because we not only need the annotation node but also the text fragment it is applied on. So the interfaces differ between normal nodes and annotation nodes.

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.

Research direction

Start by reviewing the html_exporters interface and the default annotation renderer described in the issue. Determine how exported HTML currently receives annotation nodes and their text fragments, then define an interface that supports both without breaking normal node renderers. Done means text annotations can be rendered in exported HTML through the default and custom paths.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.