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

added support for urls in include markdown tag #159

Merged
merged 3 commits into from
Jul 31, 2023

Conversation

clubanderson
Copy link
Contributor

I avoid registering the url to the file watcher so that "mkdocs serve" works fine, and mkdocs build also works. If an external url's content changes, then you would need to regenerate your docs.

@clubanderson
Copy link
Contributor Author

Can I get a review on this PR please?

@clubanderson clubanderson changed the title added support for urls in include markedown tag added support for urls in include markdown tag Jun 19, 2023
@clubanderson
Copy link
Contributor Author

Can someone review?

Copy link
Owner

@mondeja mondeja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the attempt and sorry for the delay.

src/mkdocs_include_markdown_plugin/event.py Outdated Show resolved Hide resolved
src/mkdocs_include_markdown_plugin/event.py Outdated Show resolved Hide resolved
src/mkdocs_include_markdown_plugin/event.py Outdated Show resolved Hide resolved
@mondeja mondeja linked an issue Jun 20, 2023 that may be closed by this pull request
…_file_to_include. Also repaired read_http function to get the target_url and to decode
@clubanderson
Copy link
Contributor Author

logger looks good, plural works

WARNING - Not adding a watcher for https://docs.kubestellar.io/elapsed-time/scheduler.dmd of 'include-markdown' directive at Coding Milestones/PoC2023q1/kubestellar-scheduler.md:2 not detected in the file https://docs.kubestellar.io/elapsed-time/scheduler.dmd

I am computing the elapsed time of a GH workflow and storing it in our GH Pages branch. I can then use...

{%
   include-markdown "https://docs.kubestellar.io/elapsed-time/scheduler.dmd"
   start="<!--elapsed-time-start-->"
   end="<!--elapsed-time-end-->"
%}

to embed the output into my page. This is great

Screenshot 2023-06-25 at 9 23 18 AM

@clubanderson
Copy link
Contributor Author

@mondeja ready for your review

@clubanderson
Copy link
Contributor Author

@mondeja can you review? I would like to get this into production. Thank you

@clubanderson
Copy link
Contributor Author

@mondeja can you review?

Copy link
Owner

@mondeja mondeja left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I'll continue the implementation and release a new version ASAP.

@mondeja mondeja merged commit 328a87c into mondeja:master Jul 31, 2023
@mondeja mondeja added this to the v5.0.0 milestone Jul 31, 2023
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.

Include from URL
2 participants