-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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.
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
Add Markdoc to the doc tools #11782
Add Markdoc to the doc tools #11782
Conversation
This highlights the test-builds repo, and contains the basic config to make it build on RTD. This doesn't address any integration info, but I wanted to get a basic page up to start getting SEO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy you did this work!
I noticed there are a few files that break in when loading https://test-builds.readthedocs.io/en/markdoc/ when checking the console.
It seems there are some URLs that add an extra /doc/
in the path that shouldn't be there. Example:
We should also add a limitation section here since I understand that there are no HTML files generated for each page, similar to Docusaurus: #11752 (review) |
HTML files are generated:
|
Hrm, interesting. In the tutorial/documentation page that I read about the HTML generator I'm sure it said that it was a SPA and the content was rendered on the fly, 🤷🏼 |
Co-authored-by: Manuel Kaufmann <[email protected]>
I think it's because we are using |
Yep, I just pushed up a fix. |
I don't really understand why it doesn't work reliably. If I go to the home and click on "Overview" it loads correctly. However, if I go directly to the overview page (https://test-builds.readthedocs.io/en/markdoc/docs/) it doesn't 🤷🏼 |
The build was broken, so it wasn't picking it up. |
1 similar comment
The build was broken, so it wasn't picking it up. |
Cool, it works perfect now 🚀 |
Co-authored-by: Anthony <[email protected]>
This highlights the test-builds repo,
and contains the basic config to make it build on RTD.
This doesn't address any integration info,
but I wanted to get a basic page up to start getting SEO.
📚 Documentation previews 📚
docs
): https://docs--11782.org.readthedocs.build/en/11782/dev
): https://dev--11782.org.readthedocs.build/en/11782/