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
> You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' in order to be able to install pre-releases.
38
38
39
39
40
-
## Configuration
41
-
42
-
Go to [Configuration](configuration.md) in order to see how to configure.
43
-
44
-
45
40
## Usage
46
41
47
-
Run phpDocumentor and set template as `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress`:
42
+
First, you need to [prepare your project to use phpDocumentor and VuePress to generate your API documentation](configuration.md).
48
43
44
+
After that, using that configuration you only need to generate the markdown pages from your code with **phpDocumentor** and then build your **VuePress** documentation:
$ phpdoc # This will use the `phpdoc.dist.xml` config file
53
48
54
-
> More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).
49
+
$ vuepress build docs # Where `docs/` is the directory you configured
50
+
```
55
51
52
+
Done! Your API documentation is live!
56
53
57
-
Then, you can update your VuePress pages with `vuepress` for your docs:
54
+
::: tip
55
+
If you already have a default [VuePress configuration](configuration.md#configuring-vuepress) and you want just quickly run phpDocumentor, you can use:
58
56
59
57
```bash
60
-
vuepress build docs# if you installed vuepress globally
0 commit comments