Skip to content

Commit 5822b6c

Browse files
committed
📝 🔥 Simplify configuration section in README.md
1 parent 8eb00ba commit 5822b6c

File tree

1 file changed

+2
-79
lines changed

1 file changed

+2
-79
lines changed

README.md

Lines changed: 2 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -71,86 +71,9 @@ phpdoc -d="src/" -t="docs/api/" --template="vendor/nelson6e65/phpdoc-vuepress/da
7171
> More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).
7272
7373

74-
## Setup
74+
## Configuration
7575

76-
### Configuring phpdoc
77-
78-
Add a file called `phpdoc.xml` with the following content to the root of your project and invoke the `phpdoc` command without arguments. Modify the configuration to suit your project.
79-
80-
```xml
81-
<?xml version="1.0" encoding="UTF-8" ?>
82-
<phpdoc>
83-
<parser>
84-
<visibility>public,protected</visibility>
85-
<target>build/api-cache</target>
86-
</parser>
87-
88-
<transformer>
89-
<target>docs/api</target>
90-
</transformer>
91-
92-
<transformations>
93-
<template name="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress" />
94-
</transformations>
95-
96-
<files>
97-
<directory>src</directory>
98-
</files>
99-
</phpdoc>
100-
```
101-
102-
More information about [configuring phpDocumentor](http://www.phpdoc.org/docs/latest/references/configuration.html).
103-
104-
> Yo can use [`phpdoc.dist.xml`](phpdoc.dist.xml) of this repo as a guide.
105-
106-
107-
### Configure routes in VuePress
108-
109-
Create a **`docs/.vuepress/config.js`** file like this:
110-
111-
```js
112-
module.exports = {
113-
dest: 'dist/phpdoc-vuepress',
114-
base: '/phpdoc-vuepress/',
115-
116-
markdown: {
117-
lineNumbers: false,
118-
},
119-
120-
themeConfig: {
121-
nav: [
122-
{ text: 'API', link: '/api/' },
123-
],
124-
125-
sidebar: {
126-
'/api/': [ // `docs/api/` directory
127-
{
128-
title: 'API',
129-
collapsable: false,
130-
children: [
131-
'',
132-
'classes',
133-
'interfaces',
134-
'traits',
135-
'functions',
136-
'constants'
137-
]
138-
}
139-
],
140-
'/': [
141-
''
142-
]
143-
},
144-
sidebarDepth: 3,
145-
146-
docsDir: 'docs',
147-
}
148-
}
149-
```
150-
151-
> Read mor about recommended directory structure at https://vuepress.vuejs.org/guide/directory-structure.html
152-
153-
> You can use [`docs/.vuepress/config.js`](docs/.vuepress/config.js) used in this repo as an example.
76+
See the [Configuration section in the documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/configuration.html) for setup examples.
15477

15578

15679
## Further reading

0 commit comments

Comments
 (0)