Skip to content

Commit 7b919ac

Browse files
committed
Build docs landing page.
1 parent a5024b5 commit 7b919ac

6 files changed

Lines changed: 90 additions & 38 deletions

File tree

assets/static/beeware.css

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -689,16 +689,14 @@ div#news-gutter {
689689
margin-top: 2em;
690690
}
691691

692-
.docs-Applications {
693-
float: left;
694-
padding: 1em;
692+
.apps-and-utilities {
693+
margin-top: 3em;
695694
}
696695

697-
.docs-Utilities {
698-
float: right;
699-
padding: 1em;
696+
h5.other-tools {
697+
margin-bottom: 0;
700698
}
701699

702-
.apps-and-utilities {
703-
margin-top: 3em;
700+
.project-details {
701+
margin-top: 2rem;
704702
}

assets/static/images/chaquopy.png

39.5 KB
Loading

assets/static/images/podium.png

15.2 KB
Loading
8.5 KB
Loading

assets/static/images/rubicon.png

21.8 KB
Loading

templates/docs.html

Lines changed: 84 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
<div class="banner">
77
<div class="container">
88
<p>{{ breadcrumbs(this) }}</p>
9-
<h1>{{ this.title }}</h1>
10-
<p>{{ this.summary }}</p>
9+
<h1>Documentation</h1>
10+
<p>Welcome to the BeeWare project documentation!</p>
1111
</div>
1212
</div>
1313
{% endblock %}
@@ -29,7 +29,7 @@ <h3>New to BeeWare?</h3>
2929
</div>
3030
{# {{ this.body }}#}
3131
<div class="featured-title d-flex justify-content-center">
32-
<h2>Featured Project Documentation</h2>
32+
<h2>Featured tools</h2>
3333
</div>
3434
<div class="row">
3535
<div class="col">
@@ -56,35 +56,89 @@ <h2><a href="https://briefcase.beeware.org">Briefcase</a></h2>
5656
</div>
5757
</div>
5858
<div class="apps-and-utilities">
59-
<div class="d-flex justify-content-center">
60-
<h2>Project Documentation</h2>
61-
</div>
62-
{% for child in this.children %}
63-
{% if child.sort_key %}
64-
{% if child.project_page_description %}
65-
<div class="col-md-6 docs-{{ child.title }}">
66-
<h2><a href="{{ child|url(alt=this.alt) }}">{{ child.title }}</a></h2>
67-
<div class="important-description">{{ child.project_page_description }}</div>
68-
{% for project in child.children %}
69-
{% if project.featured %}
59+
<div class="d-flex justify-content-center applications">
60+
<h3>Showcased applications</h3>
61+
</div>
62+
<div class="d-flex justify-content-center applications-description">
63+
Applications maintained by the BeeWare team that are built using BeeWare's tools.
64+
</div>
7065
<div class="clearfix project">
71-
<img src="{{ site.get(project.path, alt='_primary')|url }}{{ project.image }}" height="72px" alt="{{ project.name }}" class="pull-xs-left">
72-
<h2><a href="{{ project|url(alt=project.alt) }}">{{ project.name }}</a></h2>
73-
{{ project.short_description|safe }}
74-
{% endif %}
75-
{% endfor %}
76-
<a href="{{ child|url(alt=child.alt) }}">... and others</a>
77-
</div>
66+
<img src="/static/images/podium.png" height="48px" alt="Podium" class="pull-xs-left">
67+
<h5 class="other-tools"><a href="https://github.com/beeware/podium">Podium</a></h5>
68+
A markup-based slide presentation tool.
69+
</div>
70+
<div class="d-flex justify-content-center utilities">
71+
<h3>Utilities</h3>
72+
</div>
73+
<div class="d-flex justify-content-center utilities-description">
74+
Pieces used by other BeeWare tools that can be useful on their own.
75+
</div>
76+
<div class="clearfix project">
77+
<img src="/static/images/rubicon.png" height="48px" alt="Rubicon Obj-C" class="pull-xs-left">
78+
<h5 class="other-tools"><a href="https://rubicon-objc.beeware.org">Rubicon Objective-C</a></h5>
79+
A markup-based slide presentation tool.
80+
</div>
81+
<div class="clearfix project">
82+
<img src="/static/images/python-apple-support.png" height="48px" alt="Python Apple Support" class="pull-xs-left">
83+
<h5 class="other-tools"><a href="https://github.com/beeware/Python-Apple-support">Python Apple Support</a></h5>
84+
A markup-based slide presentation tool.
7885
</div>
79-
{% endif %}
80-
{% endif %}
81-
{% endfor %}
86+
<div class="clearfix project">
87+
<img src="/static/images/chaquopy.png" height="48px" alt="Chaquopy" class="pull-xs-left">
88+
<h5 class="other-tools"><a href="https://chaquo.com/chaquopy/">Chaquopy</a></h5>
89+
A markup-based slide presentation tool.
90+
</div>
91+
</div>
92+
<div class="d-flex justify-content-center details">
93+
<h2>BeeWare project details</h2>
94+
</div>
95+
<p>
96+
BeeWare is more than a suite of tools for building amazing apps. It's also an
97+
amazing community! Learn about how we keep our community safe and welcoming,
98+
how to contribute to BeeWare, and more about the philosophy behind the project.
99+
</p>
100+
<div class="code-of-conduct project-details">
101+
<h3>BeeWare Community Code of Conduct</h3>
102+
</div>
103+
<p>
104+
Everyone participating in the BeeWare community, in any way, is required to
105+
adhere to the guidelines in the
106+
<a href="https://beeware.org/community/behavior/code-of-conduct">BeeWare
107+
Community Code of Conduct.</a> Please familiarize yourself with it, and follow
108+
the guidelines within it. If you have any questions, concerns, or need to
109+
report an incident, please email <a href="mailto:conduct@beeware.org">
110+
conduct@beeware.org</a>.
111+
</p>
112+
<div class="contributing project-details">
113+
<h3>Contributing to the BeeWare project</h3>
114+
</div>
115+
<p>
116+
There are many ways to contribute to BeeWare. Are you interested in writing
117+
Python? You can contribute to the codebase. Are you more into documentation?
118+
There's plenty of that as well. Building an app and sharing it with us is
119+
equally important.
120+
</p>
121+
<p>
122+
TODO: More, and add links.
123+
</p>
124+
<div class="philosophy project-details">
125+
<h3>BeeWare history and philosophy</h3>
126+
</div>
127+
<p>
128+
TODO: Fill in.
129+
</p>
130+
<div class="community project-details">
131+
<h3>The BeeWare community</h3>
132+
</div>
133+
<p>
134+
Join the BeeWare community! TODO: More.
135+
</p>
136+
<p>
137+
Follow us on Mastodon
138+
<a href="https://fosstodon.org/@beeware">@beeware@fosstodon.org</a> for updates
139+
and info. For questions, information, sharing your projects, and more, join us
140+
on the <a href="https://beeware.org/bee/chat/">BeeWare Discord</a>.
141+
</p>
82142
</div>
83-
{# <div class="col-md-4">#}
84-
{# <div class="sidebar-module sidebar-module-inset gutter">#}
85-
{# {{ this.gutter }}#}
86-
{# </div>#}
87-
{# </div>#}
88143
</div>
89-
90144
{% endblock %}

0 commit comments

Comments
 (0)