You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/architecture.rst
+23-19Lines changed: 23 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,14 +3,15 @@ Architecture
3
3
============
4
4
5
5
The project is built around the core library that is called ``guides``. This library
6
-
contains all core components of the project. Like the different layers :doc:`parser`,
7
-
:doc:`compiler` and :doc:`render` and includes the basic Nodes and templates to create
6
+
contains all core components of the project. Like the different layers :ref:`parser-component`,
7
+
:ref:`compiler-component` and :ref:`renderer-component` and includes the basic Nodes and templates to create
8
8
output.
9
9
10
-
Installation of the core library can be done using ``composer``::
10
+
Installation of the core library can be done using ``composer``:
11
11
12
-
.. code:: bash
13
-
composer require phpdocumentor/guides
12
+
.. code-block:: bash
13
+
14
+
composer require phpdocumentor/guides
14
15
15
16
The other components are using the core library and extend it with additional
16
17
functionality. For example the ``guides-markdown`` component adds support for
@@ -30,18 +31,21 @@ Application flow
30
31
31
32
Processing documents is done in a few steps.
32
33
33
-
#. :php:class:`Parsing <\phpDocumentor\Guides\Parser>` The first step is to parse the document. This is done by the :doc:`parser` component. The
34
-
parser component will parse the document and create a tree of nodes. Each node
35
-
represents a part of the document. For example a paragraph, a list or a table.
36
-
#. :php:class:`Compiling <\phpDocumentor\Guides\Compiler\Compiler>` The second step is to compile the tree of nodes. This is done by the :doc:`compiler`
37
-
component. During the compilation, modifications can be made to the tree of nodes. For
38
-
example the compiler can add a table of contents to the tree of nodes.
39
-
40
-
#. :php:class:`Rendering <\phpDocumentor\Guides\Renderer\BaseTypeRenderer>` The third step is to render the tree of nodes. This is done by the :doc:`render`
41
-
component. The render component will render the tree of nodes to a specific output
42
-
format. By default twig templates are used to render nodes to HTML. But you can
43
-
create your own templates to render nodes to other formats. Or implement your own
44
-
renderer to use a different template engine.
45
-
46
-
.. uml:: _uml/application-flow.puml
34
+
#. :php:class:`Parsing <\phpDocumentor\Guides\Parser>` The first step is to parse the document.
35
+
This is done by the :ref:`parser-component` component. The
36
+
parser component will parse the document and create a tree of nodes. Each node
37
+
represents a part of the document. For example a paragraph, a list or a table.
38
+
#. :php:class:`Compiling <\phpDocumentor\Guides\Compiler\Compiler>` The second step is to compile the tree of nodes.
39
+
This is done by the :ref:`compiler-component`
40
+
component. During the compilation, modifications can be made to the tree of nodes. For
41
+
example the compiler can add a table of contents to the tree of nodes.
42
+
43
+
#. :php:class:`Rendering <\phpDocumentor\Guides\Renderer\BaseTypeRenderer>` The third step is to render
44
+
the tree of nodes. This is done by the :ref:`renderer-component`
45
+
component. The render component will render the tree of nodes to a specific output
46
+
format. By default twig templates are used to render nodes to HTML. But you can
47
+
create your own templates to render nodes to other formats. Or implement your own
0 commit comments