mathieudutour/foam-gatsby-template

Foam workpace template

Foam

👋 Welcome to your new Foam Workspace!

Getting started

This documentation assumes that you have a GitHub account and have Visual Studio Code installed on your Linux/MacOS/Windows machine.

1. If you haven't yet, browse over to the main Foam documentation workspace to get an idea of what Foam is and how to use it.

2. Press "Use this template" button at foam-gatsby-template (that's this repository!) to fork it to your own GitHub account. If you want to keep your thoughts to yourself, remember to set the repository private.

3. Clone the repository to your local machine and open it in VS Code.

   Open the repository as a folder using the File > Open... menu item. In VS Code, "open workspace" refers to multi-root workspaces.

4. When prompted to install recommended extensions, click Install all (or Show Recommendations if you want to review and install them one by one)

5. Open _layouts/gatsby-config.js and edit the pathPrefix to be the name of the repository.

After setting up the repository, open .vscode/settings.json and edit, add or remove any settings you'd like for your Foam workspace.

To learn more about how to use Foam, read the Recipes bubbles of the Foam documentation workspace.

Using Foam

We've created a few Bubbles (markdown documents) to get you started.

• [inbox] - a place to write down quick notes to be categorised later
• [foam-tips] - tips to get the most out of your Foam workspace
• [todo] - a place to keep track of things to do

Note on [[wiki-links]]

⚠️ Until foambubble/foam#16 is resolved, [[wiki-links]] links (like the links above) won't work in the GitHub Markdown preview (i.e. this Readme on github.com).

They should work as expected in VS Code, and in rendered GitHub Pages.

If GitHub preview (or general 100% support with all Markdown tools) is a requirement, for the time being you can use the standard [description](page.md) syntax.

foam-gatsby-template's Issues

Links that share the prefix name do not work

Firstly, I am sorry if this issue is better suited for the gatsby garden repo, I submit it here since I'm using the foam version.

The repository I'm referring to is https://github.com/rustype/notes and the site is https://rustype.github.io/notes/.

The page starts as expected:

However, if I click on notes the initial page repeats:

The expected behavior would be to move on to the actual note.

Question: syntax highlighting?

Trying to get prismjs to work with this. Not sure how to get this option with the theme chosen for this.

[QUESTION] deployment to gh pages only shows markdown.

I'm sure this is a noob problem, but I can't seem to solve it.

I copied the template to A personal repo which is deployed to macedo.digital/tr2/. However, it seems that the whole point of this repo, all the gatsby stuff, doesn't work.

Am I missing anything obvious? How can I fix this?

Broken GraphQL Query when running Action

When the Action runs, and it gets to the build website portion of the workflow, I get this error:

Cannot query field "gardenConfig" on type "Query".

I think I have the config set up right, but just in case, here is the repo:

https://github.com/twhite96/dev-research-gatsby

gatsby-config.js:

module.exports = {
  pathPrefix: `/dev-research`,
  siteMetadata: {
    title: `Dev Research`,
  },
  plugins: [
    {
      resolve: `gatsby-theme-garden`,
      options: {
        rootNote: "/readme",
        contentPath: `${__dirname}/..`,
        ignore: [
          "**/_layouts/**",
          "**/.git/**",
          "**/.github/**",
          "**/.vscode/**",
        ],
      },
    },
  ],
};

Selective publishing of pages of foam

How can we make some of our pages private while publishing?

Related Issue in Foam - foambubble/foam#149

cc @mathieudutour @Sholanki

gatsby build throws "Reducers may not dispatch actions"

Hi Mathieu

I love the idea, but fell at first hurdle...

error "gatsby-theme-garden" threw an error while running the createPages lifecycle:
Reducers may not dispatch actions.

After first getting this I edited _layouts/gatsby-config.js to set the pathPrefix to the subdirectory my GH Pages appears at but still same error. Any clues please?

module.exports = {
  pathPrefix: `/garden`,
  siteMetadata: {
    title: `Garden`,
  },
  plugins: [
    {
      resolve: `gatsby-theme-garden`,
      options: {
        rootNote: "readme",
        contentPath: `${__dirname}/..`,
        ignore: [
          "**/_layouts/**",
          "**/.git/**",
          "**/.github/**",
          "**/.vscode/**",
        ],
      },
    },
  ],
};

Further tests:

• did a straight fork of you repo and the build fails in the same way.
• then tried fixing the Gatsby version at the exact base version in package.json but still no change

[Question]: How to keep my foam-gatsby-template up to date with your latest development?

And also up to date with original foam?

Exclude directories from workspace for crawling performance reasons

 "files.exclude": {
    "**/node_modules": true
  },
  "files.watcherExclude": {
    "**/node_modules": true
  },

Reference From: foambubble/foam#130

[Question] How to configure gatsby to display images in markdown?

I attempted to use gatsby-remark-images plugin and gatsby-plugin-mdx according to gatsby docs but it either returns 404 for images or the image flashes and breaks the frontend. I'm thinking folder structure would be:
_layout/
notes_type1/
notes_type2/
sketch_notes_images/ --> potential sub folders
garden.md

What do you recommend?

Thanks in advance!

Broken links in deployed view

Hi Mathieu,

Really love this template. Everything looks great locally but when deployed to gh-pages, the links are broken. Example shown here: https://kodonoboken.github.io/til/

How can I fix this?

Thanks in advance!

Strange behavior of links

At first, I tried this template with some modifications but it showed some strange behavior, so I decided to use the template as it is, without any modifications (just changing the pathPrefixvalue to repo name) to see if the problem persists. It's working perfectly fine here: https://mathieudutour.github.io/foam-gatsby-template/, but when I try to run the same code here https://aadimator.github.io/foam-notes/, it behaves differently.

The problem is, that once I hover over the backlinks, it doesn't show the popover (Tippy.js) and the other thing being that if I click on a backlink inside the main content, it opens up a new page instead of using StackedPage, but when I click on the link from the Referred in section, it displays that page using StackedPages just fine. I've attached a video showcasing the above-mentioned peculiarities.

https://www.loom.com/share/698cab5d27f344108940409798135f12

Here's the link to my repo: https://github.com/aadimator/foam-notes
As you can see, it's almost exactly the same as that in the original template repo.
Can you please help me figure out the problem? Thanks

[Question] Is it possible to support folders?

Is it possible to support folders?

File Structure

Say I have these example files in a Foam project with foam generated link texts.

index.md
fruit
├── apple.md
├── orange.md

apple.md:

Apple
===

I will link [[orange]] here.

[//begin]: # "Autogenerated link references for markdown compatibility"
[orange]: orange "Orange"
[//end]: # "Autogenerated link references"

orange.md:

Orange
===

An orange is an orange is an orange.

Current problem

When clicking the orange link in the apple page ( mysite.com/fruit/apple ), the link will lead to ( mysite.com/orange ) - which will be 404.

Is there any chance that I can configure the gatsby-theme-garden to make it link to ( mysite.com/fruit/orange ) ? Though I do know that it is somehow contradictory with Roam's convention.

Github actions fails at Build website step