Gallery
See what rst-renderer produces — live HTML rendering examples
Gallery / Showcase
See the rendered output of common RST patterns.
Basic Text
Hello World
===========
This is a paragraph with **bold**, *italic*, and ``inline code``.
Another paragraph with a `literal` and *nested **markup***.Renders as:
Hello World
This is a paragraph with bold, italic, and inline code.
Another paragraph with a literal and nested markup.
Sections & Lists
Features
========
Core Capabilities
-----------------
* HTML rendering with 11 directive plugins
* React component tree generation
* Markdown conversion with GFM tables
Installation
------------
1. Install the package
2. Import and render
3. Enjoy!Renders as:
Features
Core Capabilities
- HTML rendering with 11 directive plugins
- React component tree generation
- Markdown conversion with GFM tables
Installation
- Install the package
- Import and render
- Enjoy!
Code Blocks
Usage Example
=============
.. code:: typescript
import { renderRst } from '@seqyuan/rst-renderer'
const html = renderRst(rstSource)
console.log(html)Renders as:
Usage Example
import { renderRst } from '@seqyuan/rst-renderer'
const html = renderRst(rstSource)
console.log(html)Admonitions
.. note::
This is a note admonition with important information.
.. warning::
This is a warning! Pay attention to this.
.. tip::
Pro tip: use rst-renderer for all your RST needs.Renders as:
Note
This is a note admonition with important information.
Warning
This is a warning! Pay attention to this.
Tip
Pro tip: use rst-renderer for all your RST needs.
Links & References
See the :doc:`HTML Rendering </docs/html-rendering>` page for details,
or check the `GitHub repository <https://github.com/seqyuan/rst>`_.Renders as:
See the HTML Rendering page for details, or check the GitHub repository.
Images
.. image:: /assets/og-card.png
:alt: rst-renderer
:width: 400pxRenders as:
Chinese (CJK)
单细胞分析报告
==============
使用 Cell Ranger **7.2.0** 对 ``3`` 个样本进行了分析。
样本质控
--------
* 估计细胞数：5,000
* 中位基因数：1,200
* 线粒体比例：< 5%Renders as:
单细胞分析报告
使用 Cell Ranger 7.2.0 对 3 个样本进行了分析。
样本质控
- 估计细胞数：5,000
- 中位基因数：1,200
- 线粒体比例：< 5%
Bioinformatics Report
See the Bioinformatics Report Tutorial for a full end-to-end example with Jinja2 templates, JSON metadata, wildcard plot scans, and standalone HTML delivery.
单细胞分析报告
==============
项目编号 PRJ-2026-001 · 分析日期 2026-06-05
样本质控
--------
.. list-table::
:header-rows: 1
* - 样本
- Cells
* - WT_Control
- 5120
* - KO_Treated_24h
- 4891Renders as:
单细胞分析报告
项目编号 PRJ-2026-001 · 分析日期 2026-06-05
样本质控
| 样本 | Cells |
|---|---|
| WT_Control | 5120 |
| KO_Treated_24h | 4891 |