Abstract Class yii\apidoc\renderers\GuideRenderer

Inheritanceyii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component
Subclassesyii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\html\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/renderers/GuideRenderer.php

Base class for all Guide documentation renderers

Public Methods

Hide inherited methods

MethodDescriptionDefined By
createSubjectLink() Creates a link to a subject yii\apidoc\renderers\BaseRenderer
createTypeLink() Creates a link to a type (class, interface or trait) yii\apidoc\renderers\BaseRenderer
generateApiUrl() Generate an url to a type in apidocs yii\apidoc\renderers\BaseRenderer
generateGuideUrl() Generate an url to a guide page yii\apidoc\renderers\BaseRenderer
init() yii\apidoc\renderers\BaseRenderer
render() Render markdown files yii\apidoc\renderers\GuideRenderer

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
generateLink() Generate link markup yii\apidoc\renderers\BaseRenderer
loadGuideStructure() Loads guide structure from a set of files yii\apidoc\renderers\GuideRenderer

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
GUIDE_PREFIX 'guide-' Deprecated since 2.0.1 use $guidePrefix instead which allows configuring this options yii\apidoc\renderers\BaseRenderer

Method Details

loadGuideStructure() protected method

Loads guide structure from a set of files

protected array loadGuideStructure ( $files )
$files array
render() public abstract method

Render markdown files

public abstract void render ( $files, $targetDir )
$files array

List of markdown files to render

$targetDir