fix: fix use of HTML in the descriptions to support MDX #108
Conversation
This file contains 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
During integration of our openapi specs to the new docusaurus plugin, I faced several problems with our invalid HTML descriptions. This PR fixes them: - missing `<ul>` and `<li>` - use `<br />` instead of <br>` - use markdown instead of HTML for `<blockquote>` Also removes the inline `style` tags in favor of classes, since that approach was also incompatible with MDX. To be merged after those styles are deployed in the apify-docs repo.
B4nan
added a commit
to apify/apify-docs
that referenced
this pull request
Nov 29, 2024
This PR overhauls our OpenAPI setup completely: - new API docs are available on https://docs.apify.com/api/v2-new/apify-api - use https://github.com/PaloAltoNetworks/docusaurus-openapi-docs instead of the redoc plugin - embed the OpenAPI specs to this repository (`apify-api` folder) - both the specs yaml file and the MDX files are git ignored - the spec include (not only) corrections from apify/openapi#108 - provide NPM scripts to work with the OpenAPI specs, namely - `npm start` will generate the specs as well as produce the MDX files out of them - `npm run api:rebuild` will rebuild the yaml spec file and recreate the MDX files - update docusaurus to v3.6.3 and enable `faster` mode (rust based tooling) - cache Run on Apify code hashes locally Things to discuss: - ~index page now only redirects, maybe we should move the content from the introduction section (so outside of OpenAPI specs)~ - ~folder structure~ - OpenAPI tests and schemathesis - nested readmes in openapi folder --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Jindřich Bär <jindrichbar@gmail.com>
|
closing as included in the new specs which is inlined in apify-docs |
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.
During integration of our openapi specs to the new docusaurus plugin, I faced several problems with our invalid HTML descriptions. This PR fixes them:
<ul>and<li><br />instead of<br><blockquote>Also removes the inline
styletags in favor of classes, since that approach was also incompatible with MDX.To be merged after those styles are deployed in the apify-docs repo.