Skip to content

Commit ba239b1

Browse files
committed
🆕 Twig template for index pages
1 parent 690dda3 commit ba239b1

File tree

7 files changed

+46
-54
lines changed

7 files changed

+46
-54
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
editLink: false
3+
pageClass: phpdoc-api-generated-page
4+
5+
{% block config %}
6+
7+
{% endblock %}
8+
---
9+
10+
# {% block title %}API: Documentation{% endblock %}
11+
12+
{% block content %}
13+
{% endblock %}
14+
15+
--------
16+
{% block footer %}
17+
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
18+
{% endblock %}
Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
1-
---
2-
sidebarDepth: 2
3-
editLink: false
4-
pageClass: phpdoc-api-generated-page
5-
---
1+
{% extends "_index.md.twig" %}
62

7-
# Classes
3+
{% block title %}Classes{% endblock %}
84

5+
{% block content %}
96
{% for namespace in project.indexes.namespaces|sort_asc %}
107
{%- for class in namespace.classes|sort_asc %}
118
{%- include 'struct-class.md.twig' %}
129
{%- endfor %}
1310
{% endfor %}
14-
15-
16-
--------
17-
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
11+
{% endblock %}
Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
---
2-
sidebarDepth: 2
3-
editLink: false
4-
pageClass: phpdoc-api-generated-page
5-
---
1+
{% extends "_index.md.twig" %}
62

7-
# Constants
3+
{% block title %}Constants{% endblock %}
4+
5+
{% block content %}
86

97
{% for namespace in project.indexes.namespaces|sort_asc %}
108
{%- for constant in namespace.constants|sort_asc %}
119
{%- include 'struct-constant.md.twig' %}
1210
{%- endfor %}
1311
{% endfor %}
1412

15-
16-
--------
17-
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
13+
{% endblock %}
Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
---
2-
sidebarDepth: 2
3-
editLink: false
4-
pageClass: phpdoc-api-generated-page
5-
---
1+
{% extends "_index.md.twig" %}
62

7-
# Functions
3+
{% block title %}Functions{% endblock %}
4+
5+
{% block content %}
86

97
{% for namespace in project.indexes.namespaces|sort_asc %}
108
{%- for function in namespace.functions|sort_asc %}
119
{%- include 'struct-function.md.twig' %}
1210
{%- endfor %}
1311
{% endfor %}
1412

15-
16-
--------
17-
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
13+
{% endblock %}
Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
1-
---
2-
sidebarDepth: 2
3-
editLink: false
4-
pageClass: phpdoc-api-generated-page
5-
---
1+
{% extends "_index.md.twig" %}
62

7-
# Interfaces
3+
{% block title %}Interfaces{% endblock %}
4+
5+
{% block content %}
86

97
{% for namespace in project.indexes.namespaces|sort_asc %}
108
{%- for interface in namespace.interfaces|sort_asc %}
119
{%- include 'struct-interface.md.twig' %}
1210
{%- endfor %}
1311
{%- endfor %}
1412

15-
16-
--------
17-
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
13+
{% endblock %}
Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
---
2-
sidebarDepth: 2
3-
editLink: false
4-
pageClass: phpdoc-api-generated-page
5-
---
1+
{% extends "_index.md.twig" %}
62

7-
# Traits
3+
{% block title %}Traits{% endblock %}
4+
5+
{% block content %}
86

97
::: danger Auto-generation note:
108
{# FIXME #} :bug: Some traits may use other tratis, but due to some issues the used traits are not recognized.
@@ -16,6 +14,4 @@ pageClass: phpdoc-api-generated-page
1614
{%- endfor %}
1715
{% endfor %}
1816

19-
20-
--------
21-
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
17+
{% endblock %}

data/templates/vuepress/index.md.twig

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
---
2-
editLink: false
3-
pageClass: phpdoc-api-generated-page
4-
prev: false
5-
---
1+
{% extends "_index.md.twig" %}
62

7-
# API: Introduction
3+
{% block title %}API: Introduction{% endblock %}
84

5+
{% block content %}
96
> API Documentation for **{{ project.name }}** autogenerated using [phpDocumentor](http://www.phpdoc.org/).
107

118

@@ -33,5 +30,4 @@ This represents a `protected` member.
3330
- Applied to any deprecated class, method or property: <Badge text="deprecated" type="error"/>
3431
- Applied to optional parameters in methods and functions: <Badge text="optional" type="warn"/>
3532

36-
--------
37-
_This document was automatically generated from source code comments using [phpDocumentor](http://www.phpdoc.org/)._
33+
{% endblock %}

0 commit comments

Comments
 (0)