Skip to content

Add comparison index page. #350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+132 −3
Open

Add comparison index page. #350

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2c1e2be
Add comparison index page.
ericholscher Mar 5, 2025
ca409e2
Link headers
ericholscher Mar 5, 2025
a35f854
Apply suggestions from code review
ericholscher Mar 28, 2025
01d1020
Address review feedback
ericholscher Mar 28, 2025
207dadb
Break out card into a macro to not 3x all things
ericholscher Mar 28, 2025
83293c9
Use explicit height
ericholscher Mar 28, 2025
8816067
Small fix
ericholscher Mar 28, 2025
0375378
Smae height
ericholscher Mar 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 132 additions & 0 deletions content/pages/comparisons/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
{# View this page at http://localhost:8080/comparisons/ #}

<html>
<head>
<title>Read the Docs vs Other Documentation Platforms</title>
<meta name="description" content="Compare Read the Docs features with other documentation platforms like GitHub Pages, GitBook, and Cloudflare Pages to find the best solution for your documentation needs." />
<meta name="template" content="page" />
<meta name="slug" content="comparisons" />
<meta name="status" content="hidden" />
</head>
<body>

{% import "partials/basic.html" as basic %}

<section>
{% call basic.header_lead(
header="Compare Read the Docs with other platforms")
%}
<p>
While there are many options for hosting documentation,
Read the Docs is purpose-built for technical documentation with features that make both documentation authors and readers more productive.
</p>
<p>
Compare Read the Docs with other popular documentation platforms to find the best solution for your needs.
</p>
{% endcall %}
</section>

<section>
<div class="ui very padded container">
<div class="ui three stackable cards">

<div class="card">
<div class="content">
<div class="ui basic padded segment">
<a href="{{ SITE_URL }}/comparisons/github-pages/">
<img class="ui small centered image" src="{{ SITE_URL }}/images/github-logo.svg" alt="GitHub Pages logo">
</a>
</div>
<div class="header">
GitHub Pages
</div>
<div class="meta">Static site hosting</div>
<div class="description">
GitHub Pages is great for static hosting, but lacks documentation-specific features. See how Read the Docs compares.
</div>
</div>
<a class="ui bottom attached button" href="{{ SITE_URL }}/comparisons/github-pages/">
<i class="fad fa-arrow-right icon"></i>
Compare with GitHub Pages
</a>
</div>

<div class="card">
<div class="content">
<div class="ui basic padded segment">
<a href="{{ SITE_URL }}/comparisons/gitbook/">
<img class="ui small centered image" src="{{ SITE_URL }}/images/gitbook-logo.svg" alt="GitBook logo">
</a>
</div>
<div class="header">
GitBook
</div>
<div class="meta">Documentation platform</div>
<div class="description">
GitBook offers documentation hosting but with limited flexibility. Learn how Read the Docs gives you more control.
</div>
</div>
<a class="ui bottom attached button" href="{{ SITE_URL }}/comparisons/gitbook/">
<i class="fad fa-arrow-right icon"></i>
Compare with GitBook
</a>
</div>

<div class="card">
<div class="content">
<div class="ui basic compact segment">
<a href="{{ SITE_URL }}/comparisons/cloudflare-pages/">
<img class="ui small centered image" src="{{ SITE_URL }}/images/cloudflare-pages-logo.svg" alt="Cloudflare Pages logo">
</a>
</div>
<div class="header">
Cloudflare Pages
</div>
<div class="meta">Web hosting platform</div>
<div class="description">
Cloudflare Pages is built for SPA hosting. While great for websites, it lacks documentation-specific features. See why Read the Docs is better suited for documentation needs.
</div>
</div>
<a class="ui bottom attached button" href="{{ SITE_URL }}/comparisons/cloudflare-pages/">
<i class="fad fa-arrow-right icon"></i>
Compare with Cloudflare Pages
</a>
</div>

</div>
</div>
</section>

<section>
<div class="ui very padded container">
<div class="ui grid center aligned">
<div class="row">
<div class="column twelve wide computer sixteen wide tablet">
<div class="ui basic vertical huge segment">
<h2 class="ui center aligned header">
Ready to get started? <i class="fad fa-rocket icon"></i>
</h2>

<p>
Read the Docs is the all-in-one solution that provides everything you need
for hosting great documentation, from analytics to versioning.
Try it today and see the difference!
</p>

<p>
<a class="ui large teal stackable button"
data-analytics="signup-modal"
onclick="jQuery('#signup-modal').modal('show');">
<i class="fad fa-rocket icon"></i>
Get started for free
</a>
</p>
</div>
</div>
</div>
</div>
</div>
</section>

</body>
</html>
4 changes: 1 addition & 3 deletions readthedocs_theme/templates/includes/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ <h4 class="ui sub header">Learn more</h4>
<a class="item" href="https://docs.readthedocs.io">Documentation</a>
<a class="item" href="https://docs.readthedocs.io/page/tutorial/index.html">Getting started guide</a>
<a class="item" href="https://docs.readthedocs.io/page/config-file/index.html">Configure your project</a>
<a class="item" href="/comparisons/github-pages/">Comparison to GitHub Pages</a>
<a class="item" href="/comparisons/gitbook/">Comparison to GitBook</a>
<a class="item" href="/comparisons/cloudflare-pages/">Comparison to Cloudflare Pages</a>
<a class="item" href="/comparisons/">Compare to other platforms</a>
{% endblock menu_learn %}
</div>
</div>
Expand Down