rust-lang / rust-lang/rust-mode

markdown mode in docs

Open
#100 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Emacs Lisp
Stars
1.3k
Forks
198
PR merge metrics
No merged PRs in 30d

Description

It would be lovely to have emacs use markdown mode in the docs embedded in rust files.

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 locating the documentation embedded in Rust files and checking how Emacs currently handles those sections. Then investigate the existing markdown mode integration and define the affected documentation entry points; done means embedded docs use markdown mode consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, rust
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.