Document `Markdown` styling

Open Beginner friendly
#3,089 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
markdown, python
Domain
documentation

Research direction

Start with the Markdown widget documentation and inspect how its widgets and styles are currently described. Document which widget and style applies to each part of a Markdown document, then verify that the documentation clearly explains how developers can customize the defaults.

Written by the indexing model from the issue text.

Description

documentation Task

Developers may want to style the content of a Markdown widget different from the default choices. At the moment we don't really document what widgets and styles get used for what parts of a markdown document. It would be a good idea to extend the Markdown widget documentation so they is made clear.

Dominant language
Python
Stars
37.3k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the 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 Textualize/textual

All issues in Textualize/textual

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.