Skip to content
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

Merged
merged 12 commits into from
Nov 25, 2024
Merged

Add Markdoc to the doc tools #11782

merged 12 commits into from
Nov 25, 2024

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Nov 20, 2024

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 📚

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.
@ericholscher ericholscher requested a review from a team as a code owner November 20, 2024 23:37
Copy link
Member

@humitos humitos left a 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:

docs/user/intro/doctools.rst Outdated Show resolved Hide resolved
docs/user/intro/markdoc.rst Outdated Show resolved Hide resolved
docs/user/intro/markdoc.rst Outdated Show resolved Hide resolved
@humitos
Copy link
Member

humitos commented Nov 21, 2024

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)

@ericholscher
Copy link
Member Author

HTML files are generated:

-> find out |grep html
out/index.html
out/404.html
out/docs/index.html
out/404/index.html

@humitos
Copy link
Member

humitos commented Nov 21, 2024

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, 🤷🏼

@ericholscher
Copy link
Member Author

Search works:

Screenshot 2024-11-21 at 9 51 16 AM

@humitos
Copy link
Member

humitos commented Nov 21, 2024

It seems there are some URLs that add an extra /doc/ in the path that shouldn't be there. Example:

I think it's because we are using assetPrefix together with basePath. I understand we only need basePath here: https://nextjs.org/docs/pages/api-reference/next-config-js/assetPrefix

@ericholscher
Copy link
Member Author

Yep, I just pushed up a fix.

@humitos
Copy link
Member

humitos commented Nov 21, 2024

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 🤷🏼

@ericholscher
Copy link
Member Author

The build was broken, so it wasn't picking it up.

1 similar comment
@ericholscher
Copy link
Member Author

The build was broken, so it wasn't picking it up.

@humitos
Copy link
Member

humitos commented Nov 21, 2024

The build was broken, so it wasn't picking it up.

Cool, it works perfect now 🚀

docs/user/intro/markdoc.rst Outdated Show resolved Hide resolved
docs/user/intro/markdoc.rst Outdated Show resolved Hide resolved
docs/user/intro/markdoc.rst Outdated Show resolved Hide resolved
@ericholscher ericholscher enabled auto-merge (squash) November 25, 2024 16:43
@ericholscher ericholscher merged commit f0467df into main Nov 25, 2024
3 of 5 checks passed
@ericholscher ericholscher deleted the markdoc-docs branch November 25, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants