Download the PHP package gregwar/rst without Composer
On this page you can find all versions of the php package gregwar/rst. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package rst
Short Description PHP library to parse reStructuredText documents
License MIT
Homepage https://github.com/Gregwar/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
RST
PHP library to parse reStructuredText document
Usage
The parser can be used this way:
For more information, you can have a look at test/document/document.rst and its result
test/document/document.html
Using the builder
The builder is another tool that will parses a whole tree of documents and generates an output directory containing files.
You can simply use it with:
It will parses all the files in the input directory, starting with index.rst and
scanning for dependencies references and generates you target files in the output
directory. Default format is HTML.
You can use those methods on it to customize the build:
copy($source, $destination): copy the$sourcefile or directory to the$destinationfile or directory of the buildmkdir($directory): create the$directoryin build directoryaddHook($function): adds an hook that will be called after each document is parsed, this hook will be called with the$documentas parameter and can then tweak it as you wantaddBeforeHook($function): adds an hook that will be called before parsing the document, the parser will be passed as a parameter
Abort on error
In some situation you want the build to continue even if there is some errors, like missing references:
Writing directives
Step 1: Extends the Directive class
Write your own class that extends the Gregwar\RST\Directive class, and define the
method getName() that return the directive name.
You can then redefine one of the following method:
processAction()if your directive simply tweak the document without modifying the nodesprocessNode()if your directive is adding a nodeprocess()if your directive is tweaking the node that just follows it
See Directive.php for more information
Step 2: Register your directive
You can register your directive by directly calling registerDirective() on your
Parser object.
Else, you will have to also create your own kernel by extending the Kernel class
and adding your own logic to define extra directives, see Kernel.php for more information.
Then, pass the kernel when constructing the Parser or the Builder
License
This library is under MIT license
