Skip to content

Commit 8fb3296

Browse files
agjohnsonagjohnson
authored
Merge pull request #27 from readthedocs/nienn/home-page-template
Home page template
2 parents 06ce803 + b2d8a55 commit 8fb3296

File tree

7 files changed

+168
-14
lines changed

7 files changed

+168
-14
lines changed

‎content/pages/homepage.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
title: Read the Docs
2-
subtitle: Example subtitle
1+
title:
2+
subtitle:
33
template: readthedocs/homepage
44
save_as: index.html
55
status: hidden
6-
description: Read the Docs
7-
8-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
6+
description: Read the Docs simplifies software documentation by building, versioning, and hosting of your docs, automatically. Think of it as Continuous Documentation.

‎readthedocs-theme/static/img/infographic-01.png‎

4.67 KB
Loading

‎readthedocs-theme/static/img/infographic-02.png‎

6.05 KB
Loading

‎readthedocs-theme/static/img/infographic-03.png‎

3.63 KB
Loading

‎readthedocs-theme/static/img/shutterstock-concept-of-user-manual-1315141181-2.jpg‎

540 KB
Loading

‎readthedocs-theme/templates/readthedocs/homepage.html‎

Lines changed: 114 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,119 @@
33
{% block body_id %}home{% endblock %}
44

55
{% block content %}
6-
<div class="ui container">
7-
<div class="ui segment">
8-
<h1 class="ui header">
9-
{{ page.title }}
10-
{% if page.subtitle %}<div class="sub header">{{ page.subtitle }}</div>{% endif %}
11-
</h1>
12-
13-
{{ page.content }}
6+
7+
<!-- Callout -->
8+
<section class="ui vertical segment padded" id="callout">
9+
10+
<div class="ui container">
11+
<div class="ui grid centered middle aligned">
12+
13+
<div class="row">
14+
15+
<div class="column seven wide computer nine wide tablet sixteen wide mobile">
16+
<h1 class="ui header massive">
17+
<span class="ui header">Push your docs, <br>we'll do the rest</span>
18+
</h1>
19+
<div class="ui basic vertical padded huge segment">
20+
<p>
21+
Make documentation part of your project workflow with simplified processes that automate building, versioning and hosting of your docs.
22+
</p>
23+
</div>
24+
25+
<div>
26+
<a href="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" class="ui button large secondary gradient fade">Get started!</a>
27+
<a href="./product.html" class="ui button large secondary basic">Learn more</a>
28+
</div>
29+
30+
</div>
31+
32+
<div class="column seven wide computer nine wide tablet sixteen wide mobile">
33+
<img src="/theme/img/shutterstock-concept-of-user-manual-1315141181-2.jpg"/>
34+
</div>
35+
36+
</div>
37+
38+
</div>
1439
</div>
15-
</div>
40+
41+
</section>
42+
43+
<!-- Announcements -->
44+
{% include 'readthedocs/includes/announcements.html' %}
45+
46+
<!-- Infographics -->
47+
<section class="ui vertical segment light padded" id="infographics">
48+
49+
<div class="ui container">
50+
51+
<div class="ui grid centered">
52+
<div class="row">
53+
<div class="column fourteen wide computer sixteen wide tablet">
54+
55+
<h2 class="ui header">How it works</h2>
56+
57+
<div class="ui grid stackable three column">
58+
59+
<div class="column center aligned">
60+
<div class="ui image">
61+
<img src="/theme/img/infographic-01.png"/>
62+
</div>
63+
<p>
64+
Write your documentation easily, using Markdown or reStructuredText, directly in your own IDE, as you work on what matters: your project.
65+
</p>
66+
</div>
67+
<div class="column center aligned">
68+
<div class="ui image">
69+
<img src="/theme/img/infographic-02.png"/>
70+
</div>
71+
<p>
72+
Read the Docs watches your repository and rebuilds your documentation any time you make a change.
73+
</p>
74+
</div>
75+
<div class="column center aligned">
76+
<div class="ui image">
77+
<img src="/theme/img/infographic-03.png"/>
78+
</div>
79+
<p>
80+
Set up your account with Read the Docs, add a <code>.readthedocs.yaml</code> file to set the configuration, and we'll do the rest!
81+
</p>
82+
</div>
83+
84+
</div>
85+
86+
</div>
87+
</div>
88+
</div>
89+
90+
</div>
91+
92+
</section>
93+
94+
<!-- It works -->
95+
<section class="ui vertical segment very padded" id="it-works">
96+
97+
<div class="ui container">
98+
<div class="ui grid center aligned">
99+
100+
<div class="row">
101+
<div class="column twelve wide computer sixteen wide tablet">
102+
103+
<div class="ui basic vertical huge segment">
104+
<p>
105+
We generate HTML, PDF, and EPUB formats for your project, and host and manage documentation versions for you.
106+
Whenever you push code, we'll build your docs.
107+
</p>
108+
<p>
109+
<big>Get your docs online in 5 minutes.</big>
110+
</p>
111+
</div>
112+
113+
</div>
114+
</div>
115+
116+
</div>
117+
</div>
118+
119+
</section>
120+
16121
{% endblock content %}

‎readthedocs-theme/templates/readthedocs/includes/announcements.html‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
2+
<section class="ui vertical segment" id="announcements">
3+
4+
<div class="ui container">
5+
6+
<div class="ui raised segment">
7+
<div class="ui grid stackable three column">
8+
9+
<div class="column">
10+
<div class="ui basic segment">
11+
<div><span class="ui label red">Announcement</span></div>
12+
<h4>Build errors with docutils 0.18</h4>
13+
<p>
14+
The latest Docutils and Sphinx updates have been the source of several problems on our builds. If you are experiencing problems related with this read the blog post. Well point you to several solutions.
15+
</p>
16+
<p>
17+
<a href="https://blog.readthedocs.com/build-errors-docutils-0-18/">Learn how to solve it</a>
18+
</p>
19+
</div>
20+
</div>
21+
<div class="column">
22+
<div class="ui basic segment">
23+
<div><span class="ui label primary">News</span></div>
24+
<h4>Our Sphinx theme version 1.0.0 is out</h4>
25+
<p>
26+
We have released a major version 1.0.0 of our Sphinx theme. This adds support for recent versions of Sphinx and docutils among other very cool things. Check out the blog post.
27+
</p>
28+
<p>
29+
<a href="https://blog.readthedocs.com/newsletter-september-2021/">Read more</a>
30+
</p>
31+
</div>
32+
</div>
33+
<div class="column">
34+
<div class="ui basic segment">
35+
<div><span class="ui label">Update</span></div>
36+
<h4>You are all up to date</h4>
37+
<p>
38+
We post important announcements, news and updates in this area. You can also check out our <a href="https://blog.readthedocs.com/">blog</a> or subscribe the newsletter to receive future updates first hand, plus receive our monthly report.
39+
</p>
40+
<p>
41+
<a href="#">Subscribe our newsletter</a>
42+
</p>
43+
</div>
44+
</div>
45+
46+
</div>
47+
</div>
48+
49+
</div>
50+
51+
</section>

0 commit comments

Comments
 (0)