Daily Note - January 26, 2022

🌡 Weather

Feels Like: 19.4°F

Business

• A few days ago, I looked up the GitHub API documentation to see if there is a rate limit for sending invitations to private repos. It turns out you can only send 50 invitations per day to outside collaborators! The limit doesn’t apply if you make them organization members. I don’t want to do that, so I submitted a help ticket to see what my options were.

• Today, GitHub got back to me and said there’s no way around the 50 limit. I can either queue the invitations, or make them organization members. That doesn’t work for me. In a sense, that’s a good thing because it makes things simpler for me.

• Instead, what I will do is create a zip file of all the content, upload it to LemonSqueezy, and then people will be able to download it right after buying. It gets them up and running faster.

• However, this introduced another issue around viewing the documentation. I wrote all the docs in Markdown, and GitHub automatically renders the Markdown to HTML, so everything is nice and readable, and you can link to other docs.

• I needed to make the docs readable locally. Luckily, I already knew of an app that would make this easy: Marked2. It comes with various themes out of the box, and you can also choose syntax highlighting themes. I went with the GitHub theme, and exported all the docs to HTML. I was very happy with the end result.

• Another neat thing I discovered in Marked2 was the ability to use multi-file documents. I wanted the end result to be a single HTML file that contained all the documentation, and provided links to the various sections. But instead of putting all the Markdown from all the docs inside a single Markdown file, you can keep the separate files, and reference them inside the main file, like this:

## README

<<[README.md]

# Prerequisites

<<[prerequisites.md]

# Post-installation Guides

<<[post-installation-guides.md]

# Troubleshooting

<<[troubleshooting.md]

# Customizing

<<[customizing.md]

# License

<<[LICENSE.md]

• I continued updating the feature comparison between the different flavors of Ruby on Mac. The YAML files I mentioned yesterday made this easy.

To Do

• Create a rubyonmac-issues public repo for people to report bugs and to submit feature requests.

• Submit PR to ruby-install to honor the --with-openssl-dir flag.