Skip to content

Commit 2ca0567

Browse files
committed
update readme
1 parent 6f53661 commit 2ca0567

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# DokuWiki Extension Mirror Script
1+
# DokuWiki CodeSearch
2+
3+
The CodeSearch service is powerd by [OpenGrok](https://opengrok.github.io/OpenGrok/), an open source source code search and cross reference engine. A PHP script (see below) uses the DokuWiki plugin repository API to periodically download all available DokuWiki plugins and templates, and indexes them with OpenGrok.
4+
5+
The service is hosted at https://codesearch.dokuwiki.org/ and is open to everyone.
6+
7+
## DokuWiki Extension Mirror Script
28

39
This tool will download all available DokuWiki plugins/templates and extract them to `data/src`. This is useful for DokuWiki developers who need to check if a certain DokuWiki function is used by any plugins.
410

@@ -8,13 +14,13 @@ Downloaded archives are kept in `data/meta` when extraction fails to ease debugg
814

915
The tool uses the DokuWiki [plugin repository API](https://github.com/splitbrain/dokuwiki-plugin-pluginrepo/blob/master/README-API) and will only download a plugin again when it's version changes.
1016

11-
## Setup
17+
### Setup
1218

1319
Just use composer:
1420

1521
composer install
1622

17-
## Running
23+
### Running
1824

1925
Call the mainfile:
2026

0 commit comments

Comments
 (0)