{"id":15980160,"url":"https://github.com/thinh-vu/foam-gatsby-wiki","last_synced_at":"2025-11-11T03:30:23.984Z","repository":{"id":206898514,"uuid":"717943278","full_name":"thinh-vu/foam-gatsby-wiki","owner":"thinh-vu","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-13T02:53:32.000Z","size":872,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-28T12:13:38.284Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thinh-vu.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-11-13T02:40:45.000Z","updated_at":"2023-11-13T02:40:52.000Z","dependencies_parsed_at":"2023-11-13T03:42:02.474Z","dependency_job_id":null,"html_url":"https://github.com/thinh-vu/foam-gatsby-wiki","commit_stats":null,"previous_names":["thinh-vu/foam-gatsby-wiki"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Ffoam-gatsby-wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Ffoam-gatsby-wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Ffoam-gatsby-wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thinh-vu%2Ffoam-gatsby-wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thinh-vu","download_url":"https://codeload.github.com/thinh-vu/foam-gatsby-wiki/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239587243,"owners_count":19663892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-08T00:01:52.634Z","updated_at":"2025-11-11T03:30:23.929Z","avatar_url":"https://github.com/thinh-vu.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntags:\n  - Readme\n  - Getting-Started\n---\n\n# Foam Template for Gatsby Theme Primer Wiki\n\n**👋Another Foam template that use [gatsby-theme-primer-wiki](https://github.com/theowenyoung/gatsby-theme-primer-wiki), Welcome to your new Foam Knowledge Base!**\n\n## Examples\n\n- [Demo](https://demo-wiki.owenyoung.com) - ([Source](https://github.com/theowenyoung/gatsby-theme-primer-wiki/tree/main/example))\n- [Everything I Know by Owen](https://wiki.owenyoung.com/) - ([Source](https://github.com/theowenyoung/wiki))\n- [Foam Demo](https://demo-foam.owenyoung.com/) - ([Source](https://github.com/theowenyoung/foam-template-gatsby-theme-primer-wiki))\n- [Obsidian Demo](https://demo-obsidian.owenyoung.com/) - ([Source](https://github.com/theowenyoung/obsidian-template-gatsby-theme-primer-wiki))\n- [Gatsby Starter Demo](https://demo-gatsby-starter-primer-wiki.owenyoung.com/) - ([Source](https://github.com/theowenyoung/gatsby-starter-primer-wiki))\n\n## Features\n\n- Support Local search, full-text search.\n- Support Graph Visualisation with canvas.\n- Support Tags, Tags First, Generating tag pages, also connecting with graph visualisation.\n- Support [Gitbook](https://docs.gitbook.com/integrations/github/content-configuration#summary) styled `SUMMARY.md` for custom sidebar.\n- Support `[[WikiLink]]`, But you'd better use [Link Reference Definitions](https://foambubble.github.io/foam/features/link-reference-definitions) with extensions, `\"foam.edit.linkReferenceDefinitions\": \"withExtensions\"`\n- Support Light/Dark Theme\n- Custom Header Nav Items\n- Nested sidebar\n- Support Google Analytics\n- Support Sitemap/Robot\n- SEO optimization\n- Support path prefix\n\n## Principles\n\nHere are my main ideas/principles in designing this theme.\n\n1. No vendor lock-in. The less vendor features you use, the better you'll be able to migrate. `[[Wikilink]]` is the only non-markdown feature supported by default, but nonetheless, it is recommended to use the standard markdown syntax, or if you edit with [Foam](https://github.com/foambubble/foam), please use [Wikilink](https://foambubble.github.io/foam/wikilinks) with [Link Reference Definitions](https://foambubble.github.io/foam/features/link-reference-definitions). That give us the capability change our theme, or hosted place.\n2. Use meta data instead of special characters. We should use `tags` as the document's metadata, not `#tag` in the plain text.\n3. Use tags instead of categories. Minimal subfolders.\n\n## Getting started\n\n### For new wiki\n\nThis documentation assumes that you have a GitHub account and have [Visual Studio Code](https://code.visualstudio.com/) installed on your Linux/MacOS/Windows machine.\n\n1. If you haven't yet, browse over to the main [Foam documentation](https://foambubble.github.io/foam) to get an idea of what Foam is and how to use it.\n2. Press \"Use this template\" button at [foam-template-gatsby-theme-primer-wiki](https://github.com/theowenyoung/foam-template-gatsby-theme-primer-wiki/generate) (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.\n3. [Clone the repository to your local machine](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) and open it in VS Code.\n\n   _Open the repository as a folder using the `File \u003e Open...` menu item._\n\n4. When prompted to install recommended extensions, click **Install all** (or **Show Recommendations** if you want to review and install them one by one)\n5. Delete all `.md` files you don't need, Change Site settings at `.layouts/gatsby-config.js`, change your CNAME at `.layouts/static/CNAME`, change your icon at `.layouts/static/logo.png`, commit your changes, and push to github, change your page settings at Github, make sure you set the page branch to `gh-pages`, then when github actions runed, you can visit your site.\n\nAfter setting up the repository, head to [[getting-started]] to get familiar with your new knowledge base!\n\nTo learn more about how to use **Foam**, read the [Recipes](https://foambubble.github.io/foam/recipes/recipes) bubbles of the Foam documentation workspace.\n\nAnd remember that you can always join our [Foam community on Discord](https://foambubble.github.io/join-discord/g)!\n\n### For exist wiki\n\n### Exist Wiki\n\n1. Clone this repo to your local machine\n\n```bash\ngit clone https://github.com/theowenyoung/foam-template-gatsby-theme-primer-wiki.git\n```\n\n2. Copy `.layouts`, `.github` `.gitignore` to your wiki folder.\n\n## Config\n\nSee [here](https://github.com/theowenyoung/gatsby-theme-primer-wiki#usage)\n\n## Local Preview\n\n```bash\ncd .layouts\nnpm i\nnpm start\n```\n\n\n## Deploy\n\nDeploy to Github Pages, see `.github/workflows/deploy.yml`,\n\n### Path Prefix\n\nIf you want deploy your site with prefix path, \n\n1. change `gatsby-config.js` with:\n\n```javascript\nmodule.exports = {\n  pathPrefix: `/blog`,\n}\n```\n\n2. set your build script with `gatsby build --prefix-paths`,\n\n\n3. Local Preview with `gatsby serve --prefix-paths`\n\n\nAlso see the original docs: \u003chttps://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/path-prefix/#add-to-gatsby-configjs\u003e\n\n## Using Foam\n\nWe've created a few Bubbles (markdown documents) to get you started.\n\n- [[inbox]] - a place to write down quick notes to be categorized later\n- [[getting-started]] - learn how to use your Foam workspace\n- [[todo]] - a place to keep track of things to do\n\nIn the `docs` directory you can find everything you need to learn the basics of Foam.\n\n[//begin]: # \"Autogenerated link references for markdown compatibility\"\n[getting-started]: getting-started.md \"Getting Started\"\n[inbox]: inbox.md \"Inbox\"\n[getting-started]: getting-started.md \"Getting Started\"\n[todo]: todo.md \"Todo\"\n[//end]: # \"Autogenerated link references\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinh-vu%2Ffoam-gatsby-wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthinh-vu%2Ffoam-gatsby-wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthinh-vu%2Ffoam-gatsby-wiki/lists"}