Gatsby's Obsidian | Markdown blog starter

Example

An example of a blog that works on this code base can be viewed here. By the way, I post my notes there, in particular there is a series of articles about creating my blog. If you are wondering how to create your blog from scratch.

Quick start

• Create symbol link from your Obsidian vault to ./content folder:

ln -s /path/to/obsidian/vault/folder/ ./content/

After that , in ./content directory will appear your_vault_folder_name directory with your md articles. More precisely, a link to this directory

• Replace all /content/knowledgebase to /content/your_vault_folder_name

• cp .env.examlpe .env and change:

  • METRIKA_TRACKING_ID
  • YANDEX_VERIFICATION_CODE
  • FAVICON_DOMAIN
  • EXTRA_METATAGS=metaname:metacontent,anothermetaname:anothermetacontent

Or remove values if you don't need Yandex Metrika, Yandex Webmaster, or favicons in your blog

• Replcace static/favicon.ico with your favicon

• Also you should replace siteMetadata information with your relevant data

• npm run dev

Markdown requirements

All posts should have some frontmatter fields, below you can see an example:

---
date: DD-MM-YYYY
stage: <inProgress | readyToPublish | finished>
tags: ["tag","anotherTag"]
github: https://link/to/your/repo(OPTIONAL)
---

If you want to change date format you should to apply the changes as well in gatsby-node.js Posts which have stage inProgress will not participate with the build and will not be displayed on site

DEPLOY

It is assumed,that you already have ssh connection to your remote server. Also you should specify three variables in .env file

DEPLOY_USER=user
DEPLOY_HOST=host
DEPLOY_PATH=/path/to/remove/server/folder

OTHER ENV VARS

DEPLOY_USER=user
DEPLOY_HOST=host
DEPLOY_PATH=/path/to/remove/server/folder

After that you can deploy your blog via scp, by run script npm run deploy (this is simple js wrapper around scp)