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: README.md
+6-4
Original file line number
Diff line number
Diff line change
@@ -41,14 +41,16 @@ Explore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/ph
41
41
42
42
- PHP >= 5.6
43
43
- Node.js >= 8
44
-
-[phpDocumentor](https://www.phpdoc.org/). This template is designed for **phpDocumentor2** (is also compatible with upcoming **phpDocumentor3** for PHP 7.1+ project). You can install it with composer as global requirement: `composer global require phpdocumentor/phpdocumentor`.
45
-
-[Yarn](https://yarnpkg.com) (or npm). To build the entire documentation with `vuepress`.
46
-
-[VuePress](https://v0.vuepress.vuejs.org/).`v0.x`, but may be compatible with upcoming `v1.0.0`.
44
+
-[phpDocumentor](https://www.phpdoc.org/).
45
+
-[Yarn](https://yarnpkg.com) (or npm)
46
+
-[VuePress](https://v0.vuepress.vuejs.org/).
47
47
48
+
> This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 0.x](https://v0.vuepress.vuejs.org/).
49
+
> Read more about dependencies in the [Documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/getting-started.html).
Copy file name to clipboardExpand all lines: docs/guide/getting-started.md
+30-5
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,31 @@
4
4
5
5
- PHP >= 5.6
6
6
- Node.js >= 8
7
-
-[phpDocumentor](https://www.phpdoc.org/). This template is designed for **phpDocumentor2** (is also compatible with upcoming **phpDocumentor3** for PHP 7.1+ project). You can install it with composer as global requirement: `composer global require phpdocumentor/phpdocumentor`.
8
-
-[Yarn](https://yarnpkg.com) (or npm). To build the entire documentation with `vuepress`.
9
-
-[VuePress](https://v0.vuepress.vuejs.org/). `v0.x`, but may be compatible with upcoming `v1.0.0`.
7
+
-[Yarn](https://yarnpkg.com) (or npm).
8
+
9
+
### Dependencies
10
+
11
+
This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 0.x](https://v0.vuepress.vuejs.org/).
12
+
13
+
> This template may be compatible with upcoming **phpDocumentor3** and **VuePress** v1.0.0, but will not be documented at the moment while they are unstable.
14
+
15
+
You can globally install them:
16
+
17
+
```bash
18
+
# phpDocumentor2
19
+
composer global require phpdocumentor/phpdocumentor:^2.9.0
20
+
21
+
# VuePress
22
+
yarn global add vuepress
23
+
```
24
+
25
+
> Read about [VuePress install](https://v0.vuepress.vuejs.org/guide/getting-started.html).
> More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).
39
55
40
56
57
+
Then, you can update your VuePress pages with `vuepress` for your docs:
58
+
59
+
```bash
60
+
vuepress build docs # if you installed vuepress globally
61
+
```
62
+
63
+
64
+
65
+
41
66
## Recommendations
42
67
43
68
-**Do not track the API route directory with Git**. This files are auto-generated with the `phpdoc` tool, so there is not need to track them. Add to your `.gitignore`:
0 commit comments