Add support for Zensical documentation tool #654
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 tasks
humitos
added a commit
to readthedocs/readthedocs.org
that referenced
this pull request
Nov 26, 2025
- [x] Understand the issue requirements - add mystmd to the list of supported doctools - [x] Review the doctools.rst structure and existing documentation tool pages - [x] Research mystmd tool capabilities (TypeScript/JavaScript, MyST Markdown, HTML output) - [x] Add mystmd entry to doctools.rst list with grid-item-card - [x] Create mystmd.rst documentation page with configuration instructions - [x] Verify documentation builds correctly - [x] Apply review suggestions: - Changed title to "Deploying MyST Markdown on Read the Docs" - Removed unnecessary comment about docs directory in YAML - Removed "Configuring MyST Markdown and Read the Docs Addons" section (no longer needed per jupyter-book/mystmd#2178) - Use 2-space indentation in YAML configuration block ## Summary This PR adds MyST Markdown (`mystmd`) to the supported documentation tools list at https://docs.readthedocs.com/platform/latest/intro/doctools.html with a dedicated configuration page. ### Files changed: 1. **docs/user/intro/doctools.rst** - Added grid-item-card for MyST Markdown (supports `md`, `ipynb`; written in JavaScript) 2. **docs/user/intro/mystmd.rst** - New documentation page with minimal configuration example Example repo: https://github.com/readthedocs/test-builds/tree/mystmd Demo: https://test-builds.readthedocs.io/en/mystmd/ <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>Docs: add `mystmd` to the list of supported doctools</issue_title> > <issue_description>Expand https://docs.readthedocs.com/platform/latest/intro/doctools.html with `mystmd`. Mention what are the suggested configuration (option at framework level or using a redirect: #12323) > > > * https://mystmd.org/</issue_description> > > <agent_instructions>Use readthedocs/addons#654 for reference since it's a similar task for another documentation tool</agent_instructions> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > <comment_new><author>@humitos</author><body> > Yes, together with the page that explains how to configure mystmd on Read the Docs.</body></comment_new> > </comments> > </details> - Fixes #12344 <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: humitos <244656+humitos@users.noreply.github.com> Co-authored-by: Manuel Kaufmann <humitos@gmail.com> Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update some values to support Zensical properly. Note that dark mode detection is not supported -- they use a pretty custom pattern:
data-md-color-scheme="slate"for dark mode anddata-md-color-scheme="default". We can talk more about that later.Search
Flyout
Notification