How to capture README info for all my github repos?

I have a question about strategy. I’m fairly new… <1month.

As I am gathering all my stuff from everywhere, for example, importing the technical talks that I’ve done, I’m coming to realise that PROJECT is a pretty good nucleation point. For several of these Projects, the README.md in the corresponding github repository kind of has all the description and context stuff I’d like to import into my obsidian. Therefore I’d like it to be in my Vault… but how do I get just the readmes?

I’m thinking of a few ideas, would love to hear from the community:

  • I could import all my github repos into my vault. Meh… feels dumb
  • I could get creative w/ some type of symlink situation? But I’m mostly on windows so I think it might not work very well
  • I could write a python script that goes out, gets them all, and dumps them into my vault… and set that on some scheduler.

What do people think?

If I would need this:

  1. I guess I have local copies of those projects, not only in the repository, so that I would mirror/get files from there
  2. I would use wget or curl or Invoke-WebRequest with raw URL (https://raw.githubusercontent.com/[user]/[repo]/refs/heads/[branch]/README.md)

I would go into some script to handle automation, naming, and folder structure, … if this is the case, then I would use the power of GitHub REST API (never used, know that it exists).

Cheers, Marko :nerd_face:

1 Like

the benefit of using a script approach like what you say is that I could actually set up a 2-way sync… so that after I [[add]] all my [[references]] I can save that locally and make that part of the repo… not that there’s any benefits to that project, but at least that way I could continue to pull as there’s changes to each readme.

1 Like

If you want to use Obsidian also as an editing app for your project’s README.md files, then for sure you need .git functionality in your vault :ok_hand:

Cheers, Marko :nerd_face:

1 Like

You could try the Code Styler plugin which has support for external references of files at github. See GitHub - mayurankv/Obsidian-Code-Styler: A plugin for Obsidian.md for styling codeblocks and inline code

I don’t have the link at hand, but these references had been mentioned in this forum also.