GPLv3 or later
- Execute
./generate.sh - Commit
- Push
or just execute ./generateAndPush.sh.
The documents will be generated into the docs/generated directory. It will always generated the documentations for the master as well as for the latest stable version.
Just edit the docs/*.md files. Any change you make there should be available on the developer website within a minute.
Edit the file app/helpers/Guide.php and add a new entry to the menu function. You need to define the following attributes:
titleThe name of the guide that will be displayed on the websitefileThe name of the file without the.mdextension that should be loaded when a user opens the guide. The file has to be placed in the docs directory. For instance a valueintroductionmatches docs/introduction.mddescriptionThe description of the guide. Will be usually displayed below the title on the guides site.urlThe url under which the guide should be available. For instance a value.callToActionThis is an optional parameter and defines the title of the call to action button.
Works similar as adding a new guide except that you have to make the changes in the file app/helpers/ApiReference.php.
Works similar as adding a new guide except that you have to make the changes in the file app/helpers/Home.php. Please note it is currently not possible to define a file name here. So it is more or less only possible to change existing entries or to add new teasers to external links.
{@hook Request.dispatch} // link to Request.dispatch hook
{@hook Request.dispatch description text} // link to Request.dispatch hook with different link text
{@hook # description} // link to hooks page
Note: In constrast to @link we do not check whether a hook with the given name exists.
{@link Map} // class within this namespace
{@link Piwik\DataTable\Map} // full classname
{@link \Exception} // php internal class
{@link serialize()} // php internal function
{@link getKeyName()} // method within this class
{@link $myproperty} // property within this class
{@link INDEX_NB_UNIQ_VISITORS} // constant within this class, note: a link will be only generated if the constant has a long description
{@link Map::getKeyName()} // method from any class
{@link Map::$myproperty} // property from any class
{@link Piwik\Metrics::INDEX_NB_UNIQ_VISITORS} // constant from any class, note: a link will be only generated if the constant has a long description
{@link http://piwik.org} // http link
{@link https://piwik.org} // https link
{@link mailto:test} // mailto link
{@link Map Description Text} // class within this namespace
{@link Piwik\DataTable\Map Description Text} // full classname
{@link \Exception Description Text} // php internal class
{@link getKeyName() Description Text} // method within this class
{@link $myproperty Description Text} // property within this class
{@link Map::getKeyName() Description Text} // method from any class
{@link Map::$myproperty Description Text} // property from any class
{@link http://piwik.org Description Text} // http link
{@link https://piwik.org Description Text} // https link
{@link mailto:test Description Text} // mailto link