Skip to content

Commit 924a3cb

Browse files
committed
📝 🎨 Improve instructions for dependencies
1 parent 99d491d commit 924a3cb

File tree

2 files changed

+36
-9
lines changed

2 files changed

+36
-9
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,16 @@ Explore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/ph
4141

4242
- PHP >= 5.6
4343
- 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/).
4747

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).
4850
4951
## Installation
5052

51-
Install with composer:
53+
Install `nelson6e65/phpdoc-vuepress` with composer:
5254

5355
```bash
5456
composer require --dev nelson6e65/phpdoc-vuepress

docs/guide/getting-started.md

+30-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,31 @@
44

55
- PHP >= 5.6
66
- 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).
26+
1027

1128

1229
## Installation
1330

14-
Install with composer:
31+
Install `nelson6e65/phpdoc-vuepress` with composer:
1532

1633
```bash
1734
composer require --dev nelson6e65/phpdoc-vuepress
@@ -25,7 +42,6 @@ composer require --dev nelson6e65/phpdoc-vuepress
2542
Go to [Configuration](configuration.md) in order to see how to configure.
2643

2744

28-
2945
## Usage
3046

3147
Run phpDocumentor and set template as `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress`:
@@ -38,6 +54,15 @@ phpdoc -d="src/" -t="docs/api/" --template="vendor/nelson6e65/phpdoc-vuepress/da
3854
> More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).
3955
4056

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+
4166
## Recommendations
4267

4368
- **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

Comments
 (0)