Foam: Publish to Netlify

[SanketDG]

[jevakallio]

This could be added to Recipes. Help wanted.

[Trimankaur]

Hi , I would like to work on this issue. I am a first timer so can you please suggest me steps for getting started ?

[bclinkinbeard]

Netlify's docs show the steps to follow for connecting a repo. Once connected I guess you'd need a build step to go from Markdown to HTML.

[Trimankaur]

Thank you @bclinkinbeard for the information.
I would like to be assigned this issue so that I can start working on it at the earliest.

[jevakallio]

@Trimankaur thanks for your interest! I'm not on my computer until tomorrow but will write out any "requirements" / expectations from Foam PoV tomorrow at my earliest convenience. There shouldn't be anything surprising, but since this is the first non-GH Pages based static site generation task, I haven't thought all the details through yet

Feel free to start looking at this. Foam Gatsby Template might be a good starting point for static site generation

https://mathieudutour.github.io/foam-gatsby-template/

That repo does the build in a GitHub action, but with Netlify they can do the build on their CI so you should really only need a package.json with the dependencies and a build script.

If you want to have the default theme similar to GH pages, check out the links on this bubble:
https://foambubble.github.io/foam/github-pages

You should be able to run a Jekyll build with the Primer template on Netlify to produce the same output as on GH, and then start customising from there

[synesthesia]

On reflection I think this is probably for v2 or v3 of a “Publish to Netlify” recipe, not the first pass

A subtlety might be to look at how often a build is started, so far have thought of two scenarios where building on Netlify on every push might be wasteful of build minutes (£):

• if using GistPad or other v tight sync where every file save is a push
• when running post-push GH actions e.g. Foam Janitor, which potentially generate changes and a new commit / push

This Netlify forum post may be useful.

[martinlaws]

In my opinion, a big part of the benefit of deploying to Netlify is the ability to quickly configure their Identity service for easy + secure user authentication. I'm going to tinker with setting that up for my own instance of foam-gatsby-template, and would be happy to contribute my learnings back as a recipe, would that be valuable?

[martinlaws]

In my opinion, a big part of the benefit of deploying to Netlify is the ability to quickly configure their Identity service for easy + secure user authentication. I'm going to tinker with setting that up for my own instance of foam-gatsby-template, and would be happy to contribute my learnings back as a recipe, would that be valuable?

Actually, I take this back (lol don't mind me conversing with myself here). I think I've found a simpler way to password-protect a deployed Foam instance (in my case, using foam-gatsby-template).

I've just run the built project's index.html through StatiCrypt during Netlify's build for a super simple way to password protect a deployed Gatsby Foam instance. You're welcome to try to break into mine here. I'll open a separate PR to add that as a recipe if anyone's into it and it isn't too technically complex for folks?

[riccardoferretti]

That's a really good idea! I didn't know about StatiCrypt and it looks pretty cool.

I have actually found a way to get into your site (won't share how, so that other people can give it a try).
I can say you have listed that you are currently playings 4 games, amongst which Starcraft (by the way, great taste, the most amazing game!)

Password protecting the site (or parts of it) sounds like an interesting feature!