Download the PHP package alto/rst without Composer
On this page you can find all versions of the php package alto/rst. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package rst
Short Description reStructuredText document engine: parse, query, lint, build, render, translate, and safely edit RST with minimal diffs
License MIT
Homepage https://github.com/altophp/rst
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rst
ALTO RST
ALTO RST parses reStructuredText into the ROM, a source-positioned object model you can lint, format, edit, and convert to safe HTML, preserving everything you don't touch.
The core has no runtime Composer dependencies. It supports docutils RST, Sphinx syntax, and the conventions used by Symfony documentation. Trusted extensions can add directives, roles, lint rules, fixes, formatter passes, statistics, and conversion mappings.
The full guide set lives under docs/.
| Need | Start with |
|---|---|
| Convert RST to safe HTML | Rst::sphinx()->toHtml($source) |
| Parse and inspect a document | Rst::sphinx()->parse($source) |
| Inspect targets and references | $result->references() |
| Lint a document | Linter::lint() |
| Fix, format, or edit source | FixEngine, Formatter, and Editor |
| Convert RST and Markdown | RstToMarkdown and MarkdownToRst |
| Convert a documentation directory | ProjectConverter::convertDirectory() |
| Add trusted behavior | Profile::withExtension() |
Installation
Install ALTO RST with Composer:
ALTO RST requires PHP 8.4 or later. No Python or Sphinx process is involved at runtime.
Quick Start
The result is:
Direct rendering is the shortest path when HTML is the only result you need. Output is safe by default: text is escaped, unsafe URL schemes are filtered, and file-reading directives stay disabled.
Choose the narrowest profile that matches the source:
See Parsing, Security for setup, profile, and rendering policies.
Parse a document when you need more
Parsing keeps the document tree, original byte positions, references, and recovery problems available for later operations:
Malformed input recovers into typed parser problems instead of losing source text. Reference resolution has its own report, so syntax recovery and broken document links remain distinguishable.
The same parsed model powers linting, project-wide reference resolution,
source-preserving edits, and conversion. Maintenance operations return exact
patches before anything is saved. Project conversion discovers .rst files
recursively, resolves cross-document Sphinx links, and aggregates every
unsupported, lossy, or approximate mapping for review.
Resolved footnotes, citations, and substitutions have explicit Markdown
mappings, including collision-safe anchors across expanded include files.
Code fence language names such as html+twig remain unchanged.
The documentation covers this in more depth: Linting to run and configure the recommended rules, Conversion to convert individual documents or complete projects between RST and Markdown, and Editing for conservative fixes, formatting, typed edits, diffs, and conflict-safe file persistence.
Extend
Trusted extensions add directives, roles, lint rules, fixes, formatter passes, statistics, and conversion mappings through compiled profile contracts. Read Extensions for the extension contracts and References for how local and project-wide targets, links, notes, citations, and substitutions resolve.
Documentation
- Getting started
- Rendering
- Editing
- References
- Security, and Errors
The documentation index lists these pages in site navigation order and links their focused guides.
Contributing
Contributions of all kinds are welcome. Visit the project on GitHub to report a bug, suggest a feature, or open a pull request.
Before submitting code, run:
Changes to public behavior should include tests and documentation.
Run composer coverage separately to enforce the 97% line-coverage floor.
The suite uses a pinned docutils 0.23 fixture corpus and does not run Python or
Sphinx. Set ALTO_RST_UX_CORPUS to a Symfony UX checkout to enable the optional
corpus conversion tests.
Support
ALTO RST is open source and independently maintained by Simon André. If it is useful to your work, you can support its continued development through GitHub Sponsors.
Sharing the package or starring it on GitHub also helps.
License
ALTO RST is released by ALTO PHP under the MIT License.
