Skip to content

Commit 2cda09d

Browse files
ShubhamOulkarbjohansebas
ShubhamOulkar
and
bjohansebas
authored
Feat : Add Table of Contents Component on pages (#1775)
Co-authored-by: Sebastian Beltran <[email protected]>
1 parent 7f5bf72 commit 2cda09d

35 files changed

+398
-218
lines changed

‎_includes/api/en/3x/menu.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<button id="menu-toggle" title="show table of content">On this page <span>&#x25BA;</span></button>
12
<ul id="menu">
23
<li><a href="#express">express()</a></li>
34
<li id="app-api"> <a href="#application">Application</a>
@@ -159,3 +160,4 @@
159160
</ul>
160161
</li>
161162
</ul>
163+

‎_includes/api/en/4x/menu.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
<button id="menu-toggle" title="show table of content">On this page <span>&#x25BA;</span></button>
12
<ul id="menu">
2-
33
<li id="express-api"><a href="#express">express()</a>
44
<ul id="express-menu">
55
<li><em>Methods</em></li>
@@ -136,7 +136,7 @@
136136
<ul id="res-menu">
137137
<li><em>Properties</em>
138138
</li>
139-
<li><a href="#res.app">res.app </a>
139+
<li><a href="#res.app">res.app</a>
140140
</li>
141141
<li><a href="#res.headersSent">res.headersSent</a>
142142
</li>
@@ -205,3 +205,4 @@
205205
</ul>
206206
</li>
207207
</ul>
208+

‎_includes/api/en/5x/menu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
<button id="menu-toggle" title="show table of content">On this page <span>&#x25BA;</span></button>
12
<ul id="menu">
2-
33
<li id="express-api"><a href="#express">express()</a>
44
<ul id="express-menu">
55
<li><em>Methods</em></li>

‎_includes/blog/posts-menu.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
<div id="blog-side-menu-container">
2-
<h3>
3-
<a href="/{{ page.lang }}/blog/posts">Posts</a>
4-
</h3>
5-
<ul id="blog-side-menu">
1+
<button id="menu-toggle" title="show blogs list">All Blogs <span>&#x25BA;</span></button>
2+
<ul id="menu" class="blog-side-menu">
3+
<li>
4+
<ul id="side-menu" class="active">
65
{% for post in site.posts %}
76
<li>
87
<a href="{{post.url}}">{{ post.title }}</a>
98
</li>
109
{% endfor %}
1110
</ul>
12-
</div>
11+
</li>
12+
</ul>

‎_includes/changelog/menu.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
### Versions
2-
31
- [5.x](#5.x)
4-
- [4.x](#4.x)
2+
- [4.x](#4.x)
3+
{: #side-menu .active}

‎_includes/mw-list.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@
1515
- [session](/resources/middleware/session.html)
1616
- [timeout](/resources/middleware/timeout.html)
1717
- [vhost](/resources/middleware/vhost.html)
18+
{: #side-menu .active}

‎_layouts/3x-api.html

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,23 @@
44
{% include head.html %}
55

66
<body>
7-
8-
<section class="content">
9-
10-
{% include header.html %}
11-
12-
{% include api/en/3x/menu.md %}
13-
14-
<div id="overlay"></div>
15-
16-
{{ content }}
17-
18-
</section>
7+
{% include header.html %}
8+
<div id="overlay"></div>
9+
10+
<div class="content">
11+
<nav aria-labelledby="sidebar-heading">
12+
<div class="toc-container">
13+
<h3 id="sidebar-heading" class="toc-heading"><em>On this page</em></h3>
14+
{% include api/en/3x/menu.md %}
15+
</div>
16+
</nav>
17+
<main>
18+
{{ content }}
19+
</main>
20+
</div>
1921

2022
{% include footer.html %}
2123

22-
2324
</body>
2425

2526
</html>

‎_layouts/4x-api.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
{% include head.html %}
55

66
<body>
7-
8-
<section class="content">
9-
10-
{% include header.html %}
11-
12-
{% include api/en/4x/menu.md %}
13-
14-
<div id="overlay"></div>
15-
16-
{{ content }}
17-
18-
</section>
7+
{% include header.html %}
8+
<div id="overlay"></div>
9+
10+
<div class="content">
11+
<nav aria-labelledby="sidebar-heading">
12+
<div class="toc-container">
13+
<h3 id="sidebar-heading" class="toc-heading"><em>On this page</em></h3>
14+
{% include api/en/4x/menu.md %}
15+
</div>
16+
</nav>
17+
<main>
18+
{{ content }}
19+
</main>
20+
</div>
1921

2022
{% include footer.html %}
2123

‎_layouts/5x-api.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
{% include head.html %}
55

66
<body>
7-
8-
<section class="content">
9-
10-
{% include header.html %}
11-
12-
{% include api/en/5x/menu.md %}
13-
14-
<div id="overlay"></div>
15-
16-
{{ content }}
17-
18-
</section>
7+
{% include header.html %}
8+
<div id="overlay"></div>
9+
10+
<div class="content">
11+
<nav aria-labelledby="sidebar-heading">
12+
<div class="toc-container">
13+
<h3 id="sidebar-heading" class="toc-heading"><em>On this page</em></h3>
14+
{% include api/en/5x/menu.md %}
15+
</div>
16+
</nav>
17+
<main>
18+
{{ content }}
19+
</main>
20+
</div>
1921

2022
{% include footer.html %}
2123

‎_layouts/middleware.html

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
---
22
layout: page
33
---
4-
<div id="mw-container">
5-
<div id="mw-list">
6-
{% if page.title contains 'middleware' %}
7-
{% capture readme %}{% include mw-list.md %}{% endcapture %}
8-
{% else %}
9-
{% capture readme %}{% include util-list.md %}{% endcapture %}
10-
{% endif %}
11-
{{ readme | markdownify }}
4+
5+
<nav aria-labelledby="sidebar-heading">
6+
<div class="toc-container">
7+
<h3 id="sidebar-heading" class="toc-heading"><em>Middlewares</em></h3>
8+
<button id="menu-toggle" title="show express middlewares">Middlewares <span>&#x25BA;</span></button>
9+
<ul id="menu">
10+
{% if page.title contains 'middleware' %}
11+
{% capture readme %}{% include mw-list.md %}{% endcapture %}
12+
{% else %}
13+
{% capture readme %}{% include util-list.md %}{% endcapture %}
14+
{% endif %}
15+
{{ readme | markdownify }}
16+
</ul>
1217
</div>
13-
<div id="middleware-content">
18+
</nav>
19+
20+
<main id="page-doc">
1421
{% if page.module == 'mw-home' %}
1522
{{content}}
1623

@@ -29,5 +36,4 @@
2936
<h3>ERROR: No source specified for README {{page.module}}</h3>
3037
{% endif %}
3138

32-
</div>
33-
</div>
39+
</main>

‎_layouts/page.html

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,29 @@
1010
<body class="non-en-doc">
1111
{% endif %}
1212

13-
<section class="page content">
13+
{% include header.html %}
1414

15-
{% include header.html %}
15+
<div id="overlay"></div>
1616

17-
<div id="overlay"></div>
18-
19-
{% if page.lang != 'en' %}
20-
<div id="i18n-notice-box" class="doc-box doc-notice">
17+
{% if page.lang != 'en' %}
18+
<div id="i18n-notice-box" class="doc-box doc-notice">
2119
{% include i18n-notice.html %}
22-
</div>
23-
{% endif %}
24-
<div id="page-doc" markdown="1">
25-
{{ content }}
2620
</div>
27-
</section>
21+
{% endif %}
22+
23+
{% if page.layout == 'middleware' %}
24+
<div class="content flex-row-content">
25+
{{ content }}
26+
</div>
27+
{% else %}
28+
<div class="content">
29+
<main>
30+
{{ content }}
31+
</main>
32+
</div>
33+
{% endif %}
2834

29-
{% include footer.html %}
35+
{% include footer.html %}
3036

3137
</body>
3238

‎_layouts/post.html

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,17 @@
33
{% include head.html %}
44

55
<body>
6+
{% include header.html %}
7+
<div id="overlay"></div>
68

7-
<section class="content">
8-
9-
{% include header.html %}
10-
11-
{% include blog/posts-menu.md %}
12-
13-
<div id="overlay"></div>
14-
<div id="blog-doc" markdown="1">
9+
<div class="content flex-row-content">
10+
<nav aria-labelledby="sidebar-heading">
11+
<div class="toc-container">
12+
<h3 id="sidebar-heading" class="toc-heading"><em>Blog posts</em></h3>
13+
{% include blog/posts-menu.md %}
14+
</div>
15+
</nav>
16+
<main id="blog-doc" markdown="1">
1517
{% if page.title %}
1618
<h1>{{page.title}}</h1>
1719
{% endif %}
@@ -25,8 +27,8 @@ <h2>{{page.sub_title}}</h2>
2527
<div class="blog-date">{{page.date| date: "%d %b %Y" }}</div>
2628
</div>
2729
{{ content }}
28-
</div>
29-
</section>
30+
</main>
31+
</div>
3032

3133
{% include footer.html %}
3234

0 commit comments

Comments
 (0)