Skip to content

Allow code blocks to import code from files or URLs #4236

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Blargian
Copy link
Member

@Blargian Blargian commented Aug 6, 2025

Summary

Per request, code for code blocks should be able to be imported from files or URLs.

This change will allow the user to specify file= or url= on code snippets. For example:

file=code_snippets/ClickStack/config-unstructured-logs-with-processor.yaml
url=https://raw.githubusercontent.com/ClickHouse/clickhouse-connect/refs/heads/main/examples/pandas_examples.py

The code from the file or URL will be inserted as text into the code block in the markdown when yarn build is run. The changes show as diffs (i.e the markdown files are updated with the changes) so we can commit the latest change permanently for human or LLM readers of the markdown. The advantage of this is that we can test these snippets externally and pull them from other repositories.

Checklist

Copy link

vercel bot commented Aug 6, 2025

@Blargian is attempting to deploy a commit to the ClickHouse Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Aug 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
clickhouse-docs ✅ Ready (Inspect) Visit Preview Aug 6, 2025 7:24pm

@Blargian Blargian changed the title Allow code blocks to import code from files Allow code blocks to import code from files or remotely Aug 8, 2025
@Blargian Blargian marked this pull request as ready for review August 8, 2025 21:36
@Blargian Blargian requested a review from a team as a code owner August 8, 2025 21:36
@Blargian Blargian requested a review from gingerwizard August 8, 2025 21:36
@Blargian Blargian changed the title Allow code blocks to import code from files or remotely Allow code blocks to import code from files or URLs Aug 8, 2025
@Blargian Blargian linked an issue Aug 8, 2025 that may be closed by this pull request
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.

Import code for code snippets from files
2 participants