Skip to content

Commit 37d4f8f

Browse files
matthew-carrollmatthew-carroll
authored
[Docs] - Website: Adjusted doc layout styles, added and re-arranged guides. (#2660)
1 parent f0d6c0d commit 37d4f8f

35 files changed

+704
-400
lines changed

‎doc/website/source/_data.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ navigation:
2222
- title: Super Editor
2323
url: /super-editor/guides
2424
- title: Super Reader
25-
url: /super-reader-guides
25+
url: /super-reader
2626
- title: Super Text Field
27-
url: /super-text-field-guides
27+
url: /super-text-field

‎doc/website/source/_includes/components/navMain.jinja‎

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,6 @@
11
<nav class="main">
2-
<ol class="organization-links">
3-
<!-- Hard-coded, specific top-level menu items -->
4-
{% if package.github != null %}
5-
<a href="{{ package.github.url }}" target="_blank" role="button" class="btn"><span class="fa fa-brands fa-github"></span>&nbsp;&nbsp;GitHub</a>
6-
{% endif %}
7-
8-
{% if package.discord != null %}
9-
<a href="{{ package.discord }}" target="_blank" role="button" class="btn"><span class="fa fa-brands fa-discord"></span>&nbsp;&nbsp;Discord</a>
10-
{% endif %}
11-
12-
{% if package.sponsorship != null %}
13-
<a href="{{ package.sponsorship }}" target="_blank" role="button" class="btn"><span class="fa fa-dollar-sign"></span>&nbsp;&nbsp;Sponsor</a>
14-
{% endif %}
15-
</ol>
16-
17-
<div class="organization-nav-divider">&nbsp;</div>
18-
192
{% if navigation != null %}
203

21-
<!-- Top-level menu item -->
22-
<ol>
23-
{% for item in navigation.items %}
24-
{% if item.tag == null and item.items == null %}
25-
<li><a href="{{ item.url }}" class="{{ url }}">{{ item.title }}</a></li>
26-
{% endif %}
27-
{% endfor %}
28-
</ol>
29-
304
{% if navigation.header != null %}
315
<span class="header">{{ navigation.header }}</span>
326
{% endif %}

‎doc/website/source/_includes/layouts/docs_page.jinja‎

Lines changed: 49 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,35 +33,50 @@
3333
<body>
3434
<nav class="navbar navbar-expand-lg">
3535
<div class="container">
36-
<a class="navbar-brand" href="/"><img src="/images/branding/logo.png" height="32"><span class="name">{{ package.title }}</span></a>
37-
3836
<button class="navbar-toggler" type="button" data-bs-toggle="offcanvas" data-bs-target="#drawerNav" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
3937
<span class="navbar-toggler-icon"></span>
4038
</button>
4139

4240
<div class="collapse navbar-collapse" id="navbarSupportedContent">
41+
<ul class="navbar-nav mb-lg-0 ms-auto align-items-center">
42+
<li class="nav-item">
43+
<a class="nav-link" href="/super-editor/guides/">Editor</a>
44+
</li>
45+
<li class="nav-item">
46+
<a class="nav-link" href="/super-reader/guides/">Reader</a>
47+
</li>
48+
<li class="nav-item">
49+
<a class="nav-link" href="/super-text-field/guides/">Text Field</a>
50+
</li>
51+
<li class="nav-item">
52+
<a class="nav-link" href="/contributing/">Contributing</a>
53+
</li>
54+
</ul>
55+
56+
<a href="/" class="home" title="Home"><span class="fa fa-home"></span></a>
57+
4358
<ul class="navbar-nav mb-lg-0 ms-auto align-items-center">
4459
{% if package.is_on_pub %}
4560
<li class="nav-item">
46-
<a class="nav-link" href="https://pub.dev/documentation/{{ package.name }}/latest/" target="_blank">API Docs</a>
61+
<a class="nav-link" title="API Docs" href="https://pub.dev/documentation/{{ package.name }}/latest/" target="_blank">API Docs</a>
4762
</li>
4863
{% endif %}
4964

5065
{% if package.github != null %}
5166
<li class="nav-item">
52-
<a href="{{ package.github.url }}" target="_blank"><span class="fa fa-brands fa-github"></span></a>
67+
<a title="GitHub" href="{{ package.github.url }}" target="_blank"><span class="fa fa-brands fa-github"></span></a>
5368
</li>
5469
{% endif %}
5570

5671
{% if package.discord != null %}
5772
<li class="nav-item">
58-
<a href="{{ package.discord }}" target="_blank"><span class="fa fa-brands fa-discord"></span></a>
73+
<a title="Discord" href="{{ package.discord }}" target="_blank"><span class="fa fa-brands fa-discord"></span></a>
5974
</li>
6075
{% endif %}
6176

6277
{% if package.sponsorship != null %}
6378
<li class="nav-item">
64-
<a class="nav-link" href="{{ package.sponsorship }}" target="_blank"><span class="fa fa-dollar-sign"></span></a>
79+
<a title="Sponsorship" class="nav-link" href="{{ package.sponsorship }}" target="_blank"><span class="fa fa-dollar-sign"></span></a>
6580
</li>
6681
{% endif %}
6782

@@ -105,14 +120,35 @@
105120
{{ content }}
106121
</main>
107122

108-
<!-- Table of contents for the page/article on desktop -->
109-
<nav class="table-of-contents col col-2 d-none d-xl-block">
110-
{% if tableOfContents is defined and tableOfContents.linkCountBeyondLevel(0) > 1 %}
111-
<div class="table-of-contents">
112-
{{ tableOfContents.renderHtmlList(startingLevel = 1) }}
123+
<!-- Right pane. Includes table of contents for the page/article, top-level nav, socials on desktop -->
124+
<div class="right-pane col col-2 d-none d-xl-block">
125+
<div class="content">
126+
<nav class="table-of-contents">
127+
{% if tableOfContents is defined and tableOfContents.linkCountBeyondLevel(0) > 1 %}
128+
<div class="table-of-contents">
129+
<h3>Table of Contents</h3>
130+
{{ tableOfContents.renderHtmlList(startingLevel = 1) }}
131+
</div>
132+
{% endif %}
133+
</nav>
134+
135+
<!-- Socials and Funding button -->
136+
<ol class="organization-links">
137+
<!-- Hard-coded, specific top-level menu items -->
138+
{% if package.github != null %}
139+
<a href="{{ package.github.url }}" target="_blank" role="button" class="btn"><span class="fa fa-brands fa-github"></span>&nbsp;&nbsp;GitHub</a>
140+
{% endif %}
141+
142+
{% if package.discord != null %}
143+
<a href="{{ package.discord }}" target="_blank" role="button" class="btn"><span class="fa fa-brands fa-discord"></span>&nbsp;&nbsp;Discord</a>
144+
{% endif %}
145+
146+
{% if package.sponsorship != null %}
147+
<a href="{{ package.sponsorship }}" target="_blank" role="button" class="btn"><span class="fa fa-dollar-sign"></span>&nbsp;&nbsp;Sponsor</a>
148+
{% endif %}
149+
</ol>
113150
</div>
114-
{% endif %}
115-
</nav>
151+
</div>
116152
</div>
117153
</div>
118154

‎doc/website/source/contributing/_data.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
layout: layouts/docs_page.jinja
2+
3+
navigation:
4+
show_contributors: false
5+
6+
header: Contributing
7+
8+
items:
9+
- title: Getting Started
10+
items:
11+
- title: Quickstart
12+
url: contributing/quickstart

‎doc/website/source/contributing/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Contributing Guide
3+
---
4+
Coming Soon!

‎doc/website/source/contributing/quickstart.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Contributing Guide
3+
contentRenderers: ["jinja", "markdown"]
4+
---
5+
Coming Soon!

0 commit comments

Comments
 (0)