RSM: Readable Science Markup
============================

.. important::
   **RSM is in active beta.** The language is stable and production-ready, but documentation is still evolving. We welcome feedback and bug reports via `GitHub Issues <https://github.com/aris-pub/rsm/issues>`_.

   **Publishing with Press**: You can now publish RSM manuscripts to `Scroll Press <https://scroll.press>`_, the web-native preprint archive. Press is currently in closed beta—check the website for updates.

What is RSM?
------------

RSM is a markup language for writing **web-first scientific manuscripts**. It combines:

- The **simplicity** of Markdown
- The **power** of semantic tagging
- **Built-in support** for citations and cross-references
- **Extensive affordances** for interactive figures, videos, algorithms, and mathematical proofs
- **Interactive features** like tooltips and handrails for better reading experience

**Write once, publish beautifully.** RSM manuscripts are responsive, accessible, and designed for modern web reading—not just PDFs.

.. admonition:: Quick Start

   - **Try it online**: `RSM Studio <https://rsm.studio>`_ (no installation required)
   - **Install locally**: See :ref:`installation` tutorial
   - **Publish your manuscript**: Export to HTML and publish on `Scroll Press <https://scroll.press>`_

Why RSM?
--------

Traditional LaTeX + PDF workflows were designed for printed paper. RSM is designed for pixels:

- **Responsive**: Adapts to any screen size
- **Interactive**: Click any reference to see a tooltip preview
- **Accessible**: Screen reader friendly, high contrast options, custom fonts
- **Structured proofs**: First-class support for formal mathematical writing
- **Web-native**: HTML output works everywhere, no plugins needed

See :ref:`faq` for detailed comparisons with LaTeX, Markdown, and ReStructuredText.


.. grid:: 1 2 2 2

   .. grid-item-card:: Tutorials
      :link: tutorials.html

      Writing your first manuscript with RSM and other tutorials.


   .. grid-item-card:: Reference manual
      :link: reference.html

      Complete reference of every feature and configuration option.


   .. grid-item-card:: Contribution guide
      :link: contributing.html

      Contribute by reporting a bug or requesting a feature.  Get involved by submitting
      a PR.


   .. grid-item-card:: FAQ
      :link: faq.html

      Frequently asked questions.


.. toctree::
   :maxdepth: 2
   :hidden:

   tutorials
   reference
   contributing
   faq