facebook / facebook/docusaurus

Support source code callouts in CodeBlock (numbers/steps/annotations)

Open
#10,108 15 comments 2 reactions 0 assignees View on GitHub
feature
Dominant language
TypeScript
Stars
66.2k
Forks
10k
Avg merge
1d 3h
Merged PRs (30d)
52

Description

### Have you read the Contributing Guidelines on issues?

- [X] I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#issues).

### Description

Example: https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#literals-and-source-code

![image](https://github.com/facebook/docusaurus/assets/10142624/0b733df3-4a18-4fb2-a21d-2f8a797e3d58)

![image](https://github.com/facebook/docusaurus/assets/10142624/9f5c0d5c-4bcc-4009-9f6f-0c06fb0e734e)

### Has this been requested on Canny?

_No response_

### Motivation

This feature is very useful for explaining the complex parts of the source code in the document

### API design

_No response_

### Have you tried building it?

_No response_

### Self-service

- [ ] I'd be willing to contribute this feature to Docusaurus myself.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.