Editor integration: inline Markdown source mode and a VS Code extension (plan, awaiting decisions)

Open
  • Is something wrong?
#57 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
csharp, typescript, vscode
Domain
desktop, devtools

Research direction

The plan describes a document service in SIL.TextEditing.Markdown, the fwmd CLI, a RichTextField source mode, and a VS Code extension with a .NET language server and TypeScript client. Read the proposed ADR 0034 once it lands and follow its decisions; owner decisions E-1 to E-15 are still pending. Work is ready to start after those decisions define the scope and acceptance criteria.

Written by the indexing model from the issue text.

Description

later textediting

Plan drafted 2026-11-06, with a proposed ADR 0034 that is not yet in the repo. The shape:

  • one UI-free document service in SIL.TextEditing.Markdown (analyse → findings, canonical text, paragraph-to-source map);
  • the fwmd CLI first (#51);
  • an inline source mode as a second RichTextField with a Markdown language service, which needs that language service to work on several paragraphs;
  • a VS Code extension: a .NET language server (native AOT), a thin TypeScript client and a TextMate grammar.

About 11–16 weeks over 7 phases. Owner decisions E-1 to E-15 are pending: source surface, toggle scope, undo (a narrow ADR 0003 amendment), leaving with errors, records, LSP shape, JSON-RPC, distribution, project context, language id, preview, location, publishing, npm packages, CLI shape. The ADR lands once they are decided.

Dominant language
C#
Stars
1
Forks
0
Avg merge
3h 55m
Merged PRs (30d)
36

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

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 sillsdev/motif

All issues in sillsdev/motif

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.