diff --git a/README.md b/README.md index 27583fe..23070fb 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # linked-blog-md Markdown files for the linked-blog-starter repository + +talk about how to set this up here + +blog posts to write: +- Obsidian publish alternative (steps using github actions and obsidian git extension) +- How to extend this blog post + + +notes to write: +- how does this work diff --git a/get-project-id-account-id-and-token-vercel.md b/get-project-id-account-id-and-token-vercel.md new file mode 100644 index 0000000..0c74231 --- /dev/null +++ b/get-project-id-account-id-and-token-vercel.md @@ -0,0 +1,9 @@ +--- +title: "How to get Project/Account ID and Token from Vercel" +--- +1. Go to your Project settings, you'll want to copy the project id (Project Settings > General > Project Id). Save this for later. +![[vercel-project-id.png]] +2. Then go your account id ([Personal Account Settings](https://vercel.com/account) > General > Your ID). Save this for later as well. +![[vercel-account-id.png]] +3. Finally, generate a token under ([Personal Account Settings](https://vercel.com/account) > Tokens > Create). Finally save the value of the token for the next step. +![[vercel-create-token.png]] \ No newline at end of file diff --git a/publish/README.md b/publish/README.md index 67b17d2..ad6186c 100644 --- a/publish/README.md +++ b/publish/README.md @@ -29,6 +29,6 @@ Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_mediu # Notes - `linked-blog-starter` uses [Tailwind CSS](https://tailwindcss.com) [(v3.0)](https://tailwindcss.com/blog/tailwindcss-v3). -- Markdown files are statically generated -- Html is generated using [generated GitHub flavoured markdown](https://github.com/sindresorhus/github-markdown-css) +- Markdown files are [[statically-generated|statically generated]] +- Markdown is styled using [generated GitHub flavoured markdown](https://github.com/sindresorhus/github-markdown-css) diff --git a/publish/attachments/clone-or-download-github.png b/publish/attachments/clone-or-download-github.png new file mode 100644 index 0000000..86aff6a Binary files /dev/null and b/publish/attachments/clone-or-download-github.png differ diff --git a/publish/attachments/configure-project-vercel.png b/publish/attachments/configure-project-vercel.png new file mode 100644 index 0000000..cfec19e Binary files /dev/null and b/publish/attachments/configure-project-vercel.png differ diff --git a/publish/attachments/disconnect-repo-vercel.png b/publish/attachments/disconnect-repo-vercel.png new file mode 100644 index 0000000..7c8ab3d Binary files /dev/null and b/publish/attachments/disconnect-repo-vercel.png differ diff --git a/publish/attachments/enable-actions-github.png b/publish/attachments/enable-actions-github.png new file mode 100644 index 0000000..96f1b94 Binary files /dev/null and b/publish/attachments/enable-actions-github.png differ diff --git a/publish/attachments/fork-linked-blog-starter-md.png b/publish/attachments/fork-linked-blog-starter-md.png new file mode 100644 index 0000000..f64ab69 Binary files /dev/null and b/publish/attachments/fork-linked-blog-starter-md.png differ diff --git a/publish/attachments/github-secrets-vercel.png b/publish/attachments/github-secrets-vercel.png new file mode 100644 index 0000000..6b38028 Binary files /dev/null and b/publish/attachments/github-secrets-vercel.png differ diff --git a/publish/attachments/vercel-account-id.png b/publish/attachments/vercel-account-id.png new file mode 100644 index 0000000..c70f108 Binary files /dev/null and b/publish/attachments/vercel-account-id.png differ diff --git a/publish/attachments/vercel-create-token.png b/publish/attachments/vercel-create-token.png new file mode 100644 index 0000000..3babd16 Binary files /dev/null and b/publish/attachments/vercel-create-token.png differ diff --git a/publish/attachments/vercel-project-id.png b/publish/attachments/vercel-project-id.png new file mode 100644 index 0000000..efb97de Binary files /dev/null and b/publish/attachments/vercel-project-id.png differ diff --git a/publish/connect-obsidian-vault-with-github.md b/publish/connect-obsidian-vault-with-github.md new file mode 100644 index 0000000..45f794d --- /dev/null +++ b/publish/connect-obsidian-vault-with-github.md @@ -0,0 +1,8 @@ +--- +title: "How to setup your Github repository with Obsidian" +--- +1. Clone the repository or "Download As Zip" +![[clone-or-download-github.png]] +2. Unzip the downloaded folder, then open the folder as a vault in Obsidian +3. Install the [Obsidian Git](https://github.com/denolehov/obsidian-git) community plugin +4. \ No newline at end of file diff --git a/publish/customize-linked-blog-starter.md b/publish/customize-linked-blog-starter.md new file mode 100644 index 0000000..776ef5f --- /dev/null +++ b/publish/customize-linked-blog-starter.md @@ -0,0 +1,3 @@ +- Look at Fleeting Notes website for a more comprehensive example of what this blog can be made to become. +- Linked Preview +- \ No newline at end of file diff --git a/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md b/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md new file mode 100644 index 0000000..c134efb --- /dev/null +++ b/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md @@ -0,0 +1,20 @@ +By the end of this tutorial, you'll have a github repository that will automatically publish notes to your custom website everytime you upload new notes to the `publish` folder. + +## Step-by-step instructions to setup your blog + +1. Fork the repository [linked-blog-starter-md](https://github.com/matthewwong525/linked-blog-starter-md) repository. This repository is where the publishing occurs +![[fork-linked-blog-starter-md.png]] +2. Create a [Vercel](https://vercel.com/dashboard) account then go to your dashboard then (Add New... > Project) +3. Import the repository you just forked +4. In the "Configure Project" settings (before you deploy), **set the "Framework Preset" to Next.JS** . Then click the "Deploy" button. +![[configure-project-vercel.png]] +5. After clicking the Deploy button, you'll see that the deploy failed. That's as expected. +6. OPTIONAL: Go to your [dashboard](https://vercel.com/dashboard), then click on the project you created and disconnect the git repository (Settings > Git > Disconnect) +![[disconnect-repo-vercel.png]] +7. Then, [[get-project-id-account-id-and-token-vercel|get the account id, project id and token from vercel]] +8. Now with the account id, project id, and token, go back to your forked repository and update Github secrets (Settings > Secrets > Actions). Add the following secrets: `VERCEL_ORG_ID`, `VERCEL_PROJECT_ID`, `VERCEL_TOKEN` +![[github-secrets-vercel.png]] +9. Finally, click "Actions", and enable the workflow +![[enable-actions-github.png]] +10. Now whenever any notes are uploaded to the `publish` directory of the repository, they are automatically published online! You can find the domain in Vercel under `Projects`. +11. See [[connect-obsidian-vault-with-github]] \ No newline at end of file diff --git a/publish/install-linked-blog-starter.md b/publish/install-linked-blog-starter.md new file mode 100644 index 0000000..353c6a2 --- /dev/null +++ b/publish/install-linked-blog-starter.md @@ -0,0 +1,4 @@ +1. Clone this repo by runningĀ `git clone https://github.com/matthewwong525/linked-blog-starter` +2. `cd linked-blog-starter` +3. `npm install` +4. `npm run dev` \ No newline at end of file diff --git a/publish/notes/install-linked-blog-starter.md b/publish/notes/install-linked-blog-starter.md deleted file mode 100644 index 860835a..0000000 --- a/publish/notes/install-linked-blog-starter.md +++ /dev/null @@ -1,4 +0,0 @@ -1. Clone this repo by runningĀ `git clone https://github.com/matthewwong525/linked-blog-starter` -2. `cd linked-blog-starter` -3. `npm install` -4. `npm run dev` \ No newline at end of file diff --git a/publish/posts/convert-obsidian-notes-to-common-markdown.md b/publish/posts/convert-obsidian-notes-to-common-markdown.md deleted file mode 100644 index 0658ea0..0000000 --- a/publish/posts/convert-obsidian-notes-to-common-markdown.md +++ /dev/null @@ -1 +0,0 @@ -Placeholer \ No newline at end of file diff --git a/publish/posts/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md b/publish/posts/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md deleted file mode 100644 index f6e0339..0000000 --- a/publish/posts/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md +++ /dev/null @@ -1 +0,0 @@ -Placeholder \ No newline at end of file diff --git a/publish/statically-generated.md b/publish/statically-generated.md new file mode 100644 index 0000000..4dbb481 --- /dev/null +++ b/publish/statically-generated.md @@ -0,0 +1,3 @@ +> With Static Generation, tools like Next.js try to render that page mostly like it would in the browser but at compile time. This gives us the ability to serve the entire content on first load. The scripts still hydrate the page during this process, but ideally with fewer changes or no changes at all. + +https://www.freecodecamp.org/news/static-site-generation-with-nextjs/#:~:text=With%20Static%20Generation%2C%20tools%20like,or%20no%20changes%20at%20all. \ No newline at end of file diff --git a/publish/notes/works-out-of-the-box-with-markdown-files.md b/publish/works-out-of-the-box-with-markdown-files.md similarity index 100% rename from publish/notes/works-out-of-the-box-with-markdown-files.md rename to publish/works-out-of-the-box-with-markdown-files.md