File tree Expand file tree Collapse file tree 2 files changed +51
-16
lines changed Expand file tree Collapse file tree 2 files changed +51
-16
lines changed Original file line number Diff line number Diff line change
1
+ .. include :: /include.rst.txt
2
+
3
+ ============
4
+ About Guides
5
+ ============
6
+
7
+ phpDocumentor's Guides library takes hand-written documentation in code repositories, creates an AST from that and feeds
8
+ it to a renderer to create the desired output.
9
+
10
+ As part of this goal, the Guides library itself is more of a framework where you can plug in support for an input
11
+ format, such as Restructured Text, and plug in an output format to output towards, such as HTML.
12
+
13
+ Supported Formats
14
+ =================
15
+
16
+ Input
17
+ -----
18
+
19
+ As this is a new component, the number of formats are limited and can expand in the future
20
+
21
+ - RestructuredText; Well-supported, though still work in progress
22
+ - Markdown; Early stages, not working yet
23
+
24
+ Output
25
+ ------
26
+
27
+ As this is a new component, the number of formats are limited and can expand in the future
28
+
29
+ - HTML
30
+ - LaTeX; Well-supported, though still work in progress
31
+
32
+ Usage
33
+ =====
34
+
35
+ See :doc: `usage `.
Original file line number Diff line number Diff line change 1
1
.. include :: /include.rst.txt
2
2
3
+ :project:
4
+ Guides
3
5
:version:
4
6
dev-main
5
7
@@ -16,17 +18,17 @@ Report issues
16
18
Latest public documentation
17
19
|composer_support_docs |
18
20
19
- This project contains a framework for rendering documentation. It provides a simple commandline tool to render
20
- your documentation from `reStructuredText Markup <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html >`__ and
21
- `Markdown <https://daringfireball.net/projects/markdown/ >`__. to HTML or LaTeX. And can be extended to support other
22
- formats.
21
+ If you are building your own application you can install the libraries using `Composer <https://getcomposer.org/ >`__::
23
22
24
- Besides the commandline tool it also provides a number of libraries that can be used to build your own application
25
- to render the supported formats, to any format you want. On these pages is explained how to use the commandline tool
26
- and how to use the libraries.
23
+ .. code :: bash
27
24
28
- If you are looking for a complete solution to create a documentation website then you may want to look at
29
- `PHPDocumentor <https://phpdoc.org/ >`__.
25
+ composer require phpdocumentor/guides
26
+
27
+ This will install all basic libraries needed to get started to get started.
28
+ All libraries come with support for `Symfony dependency injection <https://symfony.com/doc/current/components/dependency_injection.html >`__.
29
+ This will help you to get started with the libraries in symfony applications.
30
+
31
+ Read more about writing your own application in the :doc: `developers ` section.
30
32
31
33
.. tip ::
32
34
@@ -42,10 +44,8 @@ If you are looking for a complete solution to create a documentation website the
42
44
.. toctree ::
43
45
:hidden:
44
46
45
- installation
46
- cli/index
47
- components/index
48
- developers/index
49
- architecture
50
- reference/index
51
- contributions/index
47
+ usage
48
+ configuration
49
+ extension/index
50
+ rst-reference/index
51
+ about
You can’t perform that action at this time.
0 commit comments