diff --git a/content/pages/product.md b/content/pages/product.md new file mode 100644 index 00000000..d4406e80 --- /dev/null +++ b/content/pages/product.md @@ -0,0 +1,6 @@ +title: Product +subtitle: +template: readthedocs/product +save_as: product.html +status: hidden +description: diff --git a/readthedocs-theme/templates/readthedocs/product.html b/readthedocs-theme/templates/readthedocs/product.html new file mode 100644 index 00000000..23e42362 --- /dev/null +++ b/readthedocs-theme/templates/readthedocs/product.html @@ -0,0 +1,248 @@ +{% extends "page.html" %} + +{% block body_id %}product{% endblock %} + +{% block content %} + + +
+ +
+
+ +
+ +
+

Write docs like you code

+

+ Read the Docs simplifies the entire process of building and deploying developer documentation. With support for Sphinx, Mkdocs, and Jupyter Book, you can integrate your code and user-facing documentation using the same tools. Create beautiful documentation easily with themes, and preview every commit with pull request previews. +

+ +
+ +
+ +
+
Issue tracking
+
+
+ +
+ +
+
Version control
+
+
+ +
+ +
+
Write your docs in plain text for easy review and translation
+
+
+ +
+ +
+
Preview documentation changes before they are merged
+
+
+ +
+ +
+
Receive a Slack notification if your documentation build fails
+
+
+ +
+ +
+ +
+ Learn about the engineering workflow +
+
+ +
+
+

Write with reStructuredText or Markdown

+

+ Write documentation alongside your code, with all your same tools, enabling a culture where writers and developers both feel ownership of documentation. +

+ +
+ +
+ +
+
Empower your developers to write docs
+
+
+ +
+ +
+
Include internal and external cross references
+
+
+ +
+ +
+
+ Guides for documentation authors +
+
+ +
+
+

Easy documentation deployment for technical teams

+

+ We deploy and host your team's documentation automatically. With pull request previews you can validate all your changes, before they go live. Once you commit, we keep your documentation up to date, across all versions of your software. +

+ +
+ +
+ +
+
Always up to date
+
+
+ +
+ +
+
Automatic documentation updates
+
+
+ +
+ +
+
Host multiple documentation versions
+
+
+ +
+ +
+
+ Guides for project administrators +
+
+ +
+
+ +
+ + +
+
+

Features

+ +
+ +
+
+

Multiple formats

+

+ Of course we build and host your docs for the web, but they are + also viewable as PDFs, as single page HTML, and for eReaders. + No additional configuration is required. +

+
+
+
+ HTML + PDF +
+
+
+ +
+
+

Multiple versions

+

+ We can host and build multiple versions of your docs so having a + 1.0 version of your docs and a 2.0 version of your docs is as easy + as having a separate branch or tag in your version control system. +

+
+
+
+ Version control +
+
+
+ +
+
+

Write docs with Sphinx or Mkdocs

+

+ Documentation can be written in Markdown or reStructuredText. Write just prose documentation, or automatically pull in documentation that is written inside your code (eg. Python docstrings). +

+
+
+
+ reStructuredText + Markdown +
+
+
+ +
+
+

We build your docs on every pull request or merge

+

+ Whenever you push a commit, we build your full set of documentation and provide a fully working preview. If you decide to merge into a production version, we will update that on merge. Your docs are always up to date with your code. +

+
+
+
+ Always up to date +
+
+
+ +
+
+

The same tools your team is already using

+

+ All too often, when documentation is lacking, it's because maintaining documentation is too difficult. Using developer tools like Git lowers the bar contributing documentation, meaning your docs will see more frequent updates. +

+
+
+
+ Use familiar tools + Write docs like you code +
+
+
+ +
+
+

Webhooks

+

+ Whenever you push code to your favorite version control system, + whether that is Git, Mercurial, Bazaar, or Subversion, we will + automatically build your docs so your code and documentation are + never out of sync. +

+
+
+
+ GitHub + GitLab + Bitbucket +
+
+
+ +
+
+
+ +{% endblock content %}