Marimo <> W&B Docs POC #1956
Draft
Marimo <> W&B Docs POC #1956
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
## Summary This commit introduces the Marimo component to the documentation, enhancing the content with a new interactive element. ## Changes - Imported the Marimo component from `/snippets/Marimo.jsx`. - Replaced the `<marimo-iframe>` with the new `<Marimo>` component for better integration. ## Impact This update improves the user experience by providing a more seamless and interactive way to engage with the documentation. Closes #XXXX
This update wraps the Marimo iframe in a div and includes the Marimo snippets script for improved functionality. This change enhances the interactivity of the Marimo component within the documentation.
…imo scripts This commit updates the analytics.js file by removing the charset attribute from the second script tag, adding a new Marimo configuration script, and restructuring the consent synchronization logic. The changes ensure that analytics scripts are loaded conditionally based on user consent, improving the overall functionality and compliance with consent management practices.
…ernal content This commit updates the Marimo component and analytics.js to improve the handling of Marimo placeholders. The changes include: - Introducing a new function to fetch and process Marimo content from external files before loading the Marimo script. - Updating the Marimo component to support loading content via a file attribute, enhancing flexibility and user experience. - Restructuring the initialization logic in analytics.js to ensure proper loading of Marimo scripts and handling of DOM readiness. These updates streamline the integration of Marimo elements, ensuring they are loaded correctly and efficiently within the documentation.
…ogging This commit introduces support for inline Marimo elements in the analytics.js file, allowing for the creation of marimo-iframes from inline content. Additionally, it improves logging for both inline and file-based Marimo elements, providing clearer feedback during the initialization process. The documentation has been updated to include an example of using the new MarimoInline component for inline content, enhancing the overall user experience and interactivity of the Marimo integration.
…file-based content processing This commit removes the inline Marimo component, streamlining the integration to focus solely on file-based Marimo elements. The analytics.js file has been updated to improve the processing of markdown content, specifically extracting Python code blocks and creating corresponding HTML elements. Additionally, the documentation has been revised to reflect these changes, simplifying the usage instructions and enhancing clarity for users. This update aims to improve the overall functionality and user experience of the Marimo integration.
This commit transforms the Marimo component to be self-contained, removing the inline support and focusing on file-based content processing. It improves the loading mechanism for the Marimo script, ensuring that the script is only loaded once and that the content is fetched and processed correctly. Additionally, the analytics.js file has been updated to streamline the initialization process and enhance logging for better debugging. The removal of example files from the repository also simplifies the overall structure, improving maintainability.
…t synchronization This commit updates the analytics.js file to include a charset attribute for the second script tag, ensuring proper character encoding. Additionally, the consent synchronization logic has been refactored for better readability and maintainability, streamlining the handling of consent categories and analytics loading based on user consent. These changes aim to improve the overall functionality and compliance with consent management practices.
Contributor
📚 Mintlify Preview Links✨ Added (2 total)📄 Pages (1)
⚙️ Other (1)
📝 Changed (3 total)📄 Pages (2)
⚙️ Other (1)
🤖 Generated automatically when Mintlify deployment succeeds |
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.
Description
POC demo using molab notebook links or code snippets (injected via React component).
Doc preview: https://wb-21fd5541-marimo-test-noah-edition.mintlify.app/models/marimo
Blockers
After talking with marimo folks, it would appear that if we wanted to use snippets, we need to:
Files
/marimo-examples/*.txt: contains Python codemodels/marimo.mdx: markdown file with both snippet and iframe exampleshttps://molab.marimo.io/notebooks/nb_6iQ9rKkdccZnbQKyMrBeAN
Related issues