• [x] Add # This note in GitHub into jinja template.
• [x] For each MD note: change ![[note]] to ![[note#header]] this.
• [x] Fix spaces in jinja template.
• [ ] Add tests for the script.
• [x] Exclude .github directory.
• [x] Exclude DO NOT COMMIT directory.
• [x] HTML-encode file and folder names in links.
• [x] Provide relative paths in stead of absolute ones for template.
• [ ] Test that all 3 URLs work.
• [x] Refactor script (and fix the buggy behaviour).
• [x] Always overwrite everything below %% comment line.

File Additions

• Script: obsidian-hub/.github/scripts/add-edit-on-github.py
• Jinja template: obsidian-hub/.github/templates/footer.md.jinja

Script explanation

• Walks through the filetree to search for markdown files.
• For each file, checks whether or not a particular comment has been written.
• If it has the comment: Replace it with the template.
• If the comment is not present: Add the template.
• If the entire template is present: Do nothing.
• Has a LOG boolean that can be set to enable/disable informational logging.
• Assumes that the script is ran from obsidian-hub directory.

Template explanation

• Taken directly from the issue discussion from #154.

Checklist

• [x] I have renamed all attached images with descriptive file names (or I did not include any images)
• [x] Before creating a new note, I searched the vault (or I only edited existing notes) => Did not change notes, only scripts.
• [x] (Optional) In case I created a new note in the folder 04 - Guides, Workflows, & Courses, I added a link to the new note(s) in one of the for {group X} overviews (listed here).

Added

A script that retrieves all issues with the labels documentation, help wanted, and good first issue . As discussed here: https://discord.com/channels/686053708261228577/915679988118863933/937297550044708934

To test this you can run the update_issues.py script You need a github api key in the apikey parameter, the api key does not need any permissions, just needs to exists to not hit any rate limits.

The current implementation would hit the rate limit once there are around 1.666 plugins.

ToDo

• [ ] Link to this in #273
• [X] add a GH action that runs every day, and creates a PR if necessary
• [X] Decide on a good location & name for the output file
• [ ] Decide on any other labels that might be added
• [X] Write some introductory text
• [ ] Do the same thing for themes?
• [X] Sort the output properly(currently sorted by plugin entry date to the list)

Checklist

• [X] before creating a new note, I searched the vault
• [X] new notes have the .md extension
• [ ] (if applicable) attached images have descriptive file names
• [ ] (if applicable) for new notes in the folder "04 - Guides, Workflows, & Courses", I added a link to them in one of the "for {group X}" overviews: https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/%F0%9F%97%82%EF%B8%8F+04+-+Guides%2C+Workflows%2C+%26+Courses

• Bible Study with Obsidian video
• The Bible Reference Plugin will let you "fetch" a particular passage of the Bible from the ESV.org.
• Chris Wilson has a youtube video about how he takes notes on the Bible.
• This blog post from Mark McElroy is useful: https://markmcelroy.com/spatial-models-for-relating-ideas/

Actual Behavior

1. before changing the title
2. after changing the title

Suggested Behavior

1. before changing the title
2. after changing the title

• [ ] Let me know if it should be changed to the suggested behavior.

Fix for #264 as mentioned in #262

Edited

• Made some additions to dy-sh's author page, such as their YouTube link and the course playlist
• Added course to Guides for Beginners with a note that it's specifically for Russian speakers

Added

A new note for the Obsidian Training Course in Russian, incl. a link to the playlist + the embed of the first part, with the description adapted from what dy-sh added in the renaming PR. I also cross-referenced some of the other guides.

Checklist

• [x] before creating a new note, I searched the vault
• [x] new notes have the .md extension
• [x] (if applicable) attached images have descriptive file names
• [x] (if applicable) for new notes in the folder "04 - Guides, Workflows, & Courses", I added a link to them in one of the "for {group X}" overviews: https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/%F0%9F%97%82%EF%B8%8F+04+-+Guides%2C+Workflows%2C+%26+Courses

In the roundup file 2022-11-12: Stable Diffusion, Clean Dashboards and 2022 Workflows, there is a line:

💎Eleanor got Lasik on Thursday so she's trying to take it easy this weekend. This issue was guest edited by [Curtis McHale](https://curtismchale.ca).## In The Community

The text ## In The Community should be on a new line. I have been unable to figure out the cause of the problem.

    I will log an issue for the `## In The Community` not being at the start of a line.

Originally posted by @claremacrae in https://github.com/obsidian-community/obsidian-hub/pull/534#discussion_r1022121167

Candidate tasks:

• [x] Updating theme download counts
  • Part of Updating Extensions
• [x] Adding new theme, plugin and people pages
  • Part of Updating Extensions
• [x] Generating the MOCs
  • Updating MOC files
• [x] Running the Python tests
  • Testing Python Code with Approval Tests
• [x] Turn off progress display on the slower scripts - they make the logs hard to read
• [x] Make it create a PR
• [x] Decide which things happen only on main - and adjust the YAML to implement that
• [x] Or decide what will trigger the job that creates commits - maybe a nightly cron job?
  • update_hub will only run on manual trigger, and only on main branch
  • The other two will run on pushes and PRs
  • So the workflow for updating releases will be:
    • Trigger update_hub
    • 3 minutes later, review and accept PR
    • Pull the changes to your branch
    • Run update_releases.py with --overwrite
    • Review and push edits
  • Over time, we should be eventually able to add the --overwrite step to update_hub.yml
• [x] Finish addressing comments from code review
• [x] Remove push and pr triggers on update_hub

After Merge

• Moved to #278
  • The steps for updating releases will be much simpler, as most of the steps will now be automated
  • I (Clare) have some shelved notes for this, in my fork
• [x] Adjust the branch protection to enable "checks must have passed on protected branch" - this will then show any errors nice-and-obviously in PRs
• Moved to #280

Defer to later on

Probably add new issues for these, if they don't exist already

• Moved to #282
• Moved to #281

Edited

• checklist for reviewers
• scripting MOC

Added

• "Adding footers" note

Checklist

• [x] before creating a new note, I searched the vault
• [x] new notes have the .md extension
• [ ] (if applicable) attached images have descriptive file names
• [ ] (if applicable) for new notes in the folder "04 - Guides, Workflows, & Courses", I added a link to them in one of the "for {group X}" overviews: https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/%F0%9F%97%82%EF%B8%8F+04+-+Guides%2C+Workflows%2C+%26+Courses

This fixes #261 - see the detail there for more information.

Edited

• Updated the author's 5 plugin pages to use new account name
• Removed the note for the old account name
• Manually updated the URL in the note for the new account name

(For this last point, a better solution would be to put in a PR to whichever of the manifest.json files might have the old account name...)

Edited: All the plugin category pages to add plugin descriptions

This uses descriptions extracted from the plugin pages themselves. This was @claremacrae's excellent idea since it retains any descriptions for plugins that are no longer present in the json feed.

This is intended as a one-time manual content adjustment. It was scripted to produce, but these areas of the category pages appear to be manually curated by humans, not machine generated, so I hesitate to introduce anything that manipulates them. Because of that the code that generates this is very strict and only manipulates lines that appear to be exactly a link to the target plugin page. There are a few examples where descriptions are not present or where the link line has been edited -- these lines have all been left exactly as they were. For example in the discontinued plugins page

- [[obsidian-extra-md-commands|Extra Markdown Commands]] (use [[obsidian-smarter-md-hotkeys|Smarter Markdown Hotkeys]] instead.)

Additionally this PR does not add descriptions to the uncategorized plugins page, as that has been automated in the related PR #551

This is another step in the overall progression of encouraging descriptions on all the plugin pages as described in #343

Code

Please forgive that this is not in python. As a throw-away one-time script I did it in the language that I know best. If we end up pursuing some ongoing automation, of course it will be in python. This script is meant to run in the root of the repository.

#!/usr/bin/env ruby

descriptions_hash = {} # key: page_name, value: description
Dir["02 - Community Expansions/02.05 All Community Expansions/Plugins/*.md"].map do |plugin_page_path|
  contents = File.read(plugin_page_path)
  if contents =~ /Mobile compatible: .*\n\n(.*)\n\n%% -----/
    descriptions_hash[File.basename(plugin_page_path, '.md')] = $1&.strip
  end
end

Dir["02 - Community Expansions/02.01 Plugins by Category/*.md"].each do |category_page_path|
  contents = File.readlines(category_page_path)
  in_list = false
  out_list = false
  new_contents = contents.map do |line|
    out_list = true if in_list && line =~ /^## /
    in_list = true if line =~ /^## Plugins in this category/

    if in_list && !out_list
      if line =~ /^- \[\[(.*?)(?:\|(.*)){0,1}\]\]\s*\n$/
        page_name, link_alias = $1, $2
        p page_name: page_name, link_alias: link_alias, line: line
        description = descriptions_hash[page_name]
        if !description.nil?
          "- [[#{page_name}|#{link_alias}]]: #{description}\n"
        else
          line # no description, leave it alone.
        end
      else
        line # leave the line alone.
      end
    else
      line
    end
  end

  File.write(category_page_path, new_contents.join)
end

Edited

• Updated YAML from matter in markdown files - the update correctly handles an empty array - quotes special characters in strings - including strings with embedded strings
• Some incidental whitespace changes like trailing whitespace

Added

• No new content here

Checklist

• [x] before creating a new note, I searched the vault
• [x] new notes have the .md extension
• [x] (if applicable) attached images have descriptive file names
• [x] (if applicable) for new notes in the folder "04 - Guides, Workflows, & Courses", I added a link to them in one of the "for {group X}" overviews: https://publish.obsidian.md/hub/04+-+Guides%2C+Workflows%2C+%26+Courses/%F0%9F%97%82%EF%B8%8F+04+-+Guides%2C+Workflows%2C+%26+Courses

Edited

Added only a link to my guide how to use the new 1.0 variables

Checklist

• [x] before creating a new note, I searched the vault
• [x] new notes have the .md extension

On the plugin page for Stenography, the direct Obsidian link is incorrect.

It's currently: obsidian://show-plugin?id=obsidian-stenography-plugin

But should be: obsidian://show-plugin?id=stenography-obsidian

I just noticed thanks to this: https://discord.com/channels/686053708261228577/694233507500916796/1050499532326187038 that the plugin download numbers in the hub are quite inflated.

This is because the service used to get the badges sums up downloads for all files, from all releases.

The official script only counts downloads for the manifest.json, since Obsidian downloads these files automatically:

• manifest.json
• main.js
• styles.css (if existing)

Depending on if styles.css exits your numbers are inflated by 2 or 3 times.

Background

When earlier Roundup pages were imported to the hub, someone went through manually converting GitHub links to hub links.

For example:

• This on the hub: 2021-07-03: Sync Updates, URI improvements, & workflows
  • contains the [[initiative-tracker|Initiative Tracker]] plugin ...
• Whereas the original page 2021-07-03: Sync Updates, URI improvements, & workflows:
  • contains the [Obsidian Initiative Tracker](https://github.com/valentine195/obsidian-initiative-tracker) ...

Linking to Hub's plugin or theme note is a bit more useful for users, as those notes are more feature-rich than just going directly to the GitHub page.

Recently, we have been importing Roundup pages with no curation (which is fine) - so all links are retained, as-is.

Suggestion

Where a GitHub repo URL in a roundup page matches the URL in a plugin or theme note, we could replace the link so that the roundup page instead links to the corresponding note instead.

When roundup articles are processed initially, they often refer to plugins or themes being reviewed and not yet officially approved, and therefore not yet having pages in the Hub.

Therefore this would be more effective if it could be run retrospectively on existing roundup hub pages.

Issue

As of late November 2022, we have the following Roundup articles:

• ...
• 2022-03-19 Better Citations Workflows & Native Callout Boxes.md
• [a gap]
• 2022-05-21 Database Discussions & Improved Search Options.md
• ...

It would be nice to fill in the dates between those two.

Information

They have disappeared from the RSS feed, hence the script update_roundup.py not picking them up.

There are HTML versions at:

https://www.obsidianroundup.org/tag/roundup/

Maybe @eleanorkonik could supply us the raw files and we could format them. But she is busy.

So maybe we just download them from HTML and use the same library for markdown conversion as is used in update_roundup.py

In 02 - Community Expansions/02.05 All Community Expansions/Themes/Micro Mike.md - added in #534 - several new Themes have broken images.

The problem files are:

• 02 - Community Expansions/02.05 All Community Expansions/Themes/Fusion.md
• 02 - Community Expansions/02.05 All Community Expansions/Themes/Micro Mike.md
• 02 - Community Expansions/02.05 All Community Expansions/Themes/SynthWave.md
• 02 - Community Expansions/02.05 All Community Expansions/Themes/ion.md

It looks to me like the images are being read from master, but the correct branch is main.

This image does not exist: https://github.com/ThisTheThe/MicroMike/raw/master/screenshotThumb.png

This one does: https://github.com/ThisTheThe/MicroMike/raw/main/screenshotThumb.png

The same applies to several other pages in the same PR.

Originally posted by @claremacrae in https://github.com/obsidian-community/obsidian-hub/pull/534#discussion_r1022122790