Skip to content

Add Markdoc to the doc tools #11782

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

Merged
merged 12 commits into from
Nov 25, 2024
Merged

Add Markdoc to the doc tools #11782

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b6254f7
Add Markdoc to the doc tools
ericholscher Nov 20, 2024
0f184f9
Add to toctree
ericholscher Nov 20, 2024
671dc08
Apply suggestions from code review
ericholscher Nov 21, 2024
7f67d21
Update docs/user/intro/markdoc.rst
ericholscher Nov 21, 2024
6be07b5
Update docs/user/intro/markdoc.rst
ericholscher Nov 21, 2024
31732c1
Update docs/user/intro/markdoc.rst
ericholscher Nov 21, 2024
2d1df13
Update docs/user/intro/markdoc.rst
ericholscher Nov 21, 2024
12bb32b
Update docs/user/intro/markdoc.rst
ericholscher Nov 21, 2024
e016dd9
Add Supported Features
ericholscher Nov 21, 2024
0234608
Fix whitespace
ericholscher Nov 21, 2024
a729ada
Apply suggestions from code review
ericholscher Nov 25, 2024
7bb66e4
Review feedback
ericholscher Nov 25, 2024
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
18 changes: 15 additions & 3 deletions docs/user/intro/markdoc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,23 @@ you need to generate static HTML from the Next JS build:
...nextConfig,
});

Quick start
-----------
Supported Features
------------------

- If you have an existing Markdoc project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.
.. csv-table:: Supported Features
:header: "Feature", "Description", "Supported"

"Pull request previews", "Preview changes to your documentation before merging.", "✅"
"Versioning", "Supports multiple versions of your documentation.", "✅"
"Search", "Provides full-text search capabilities.", "✅"
"Flyout menu", "Provides a flyout menu for navigation.", "✅"
"Offline formats", "Generates PDF and ePub formats.", "❌"
"Localization", "Supports multiple languages.", "❌"

Getting started
---------------

- If you have an existing Markdoc project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.
- If you're new to Markdoc, check out the official `Getting started with Markdoc`_ guide.

.. _Getting started with Markdoc: https://markdoc.io/docs/getting-started
Expand Down