From 907ef9cbd38ef0b282929bae177dd60e455dc3fc Mon Sep 17 00:00:00 2001 From: Ola Rubaj <52197250+olayway@users.noreply.github.com> Date: Fri, 28 Jul 2023 14:52:28 +0200 Subject: [PATCH] [site/content][s]: delete duplicate howtos --- .../blog/edit-or-add-md-pages-locally.md | 61 ------------------- .../blog/edit-text-on-a-single-md-page.md | 52 ---------------- .../howtos/edit-or-add-md-pages-locally.md | 3 + .../howtos/edit-text-on-a-single-md-page.md | 9 ++- 4 files changed, 9 insertions(+), 116 deletions(-) delete mode 100644 site/content/blog/edit-or-add-md-pages-locally.md delete mode 100644 site/content/blog/edit-text-on-a-single-md-page.md diff --git a/site/content/blog/edit-or-add-md-pages-locally.md b/site/content/blog/edit-or-add-md-pages-locally.md deleted file mode 100644 index 3856ad55..00000000 --- a/site/content/blog/edit-or-add-md-pages-locally.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: How to edit or add Markdown-based pages locally on your computer -date: 2023-07-27 -authors: ['Jake Hirsch', 'Ola Rubaj'] -filetype: 'blog' ---- - -## Intro - -In this How to, you will learn how to edit or add Markdown based pages locally on your computer. This offers a range of unique functions, including the ability to automatically link to other pages as well as a simple way to preview the site. - -## Prerequisites - -- A github account -- A github desktop app -- Obsidian - -## Steps - -### Step 1: Clone the GitHub repository to your local machine - -1.1. Go to https://github.com/ and navigate to the repository you want to clone. -1.2. Click the `<> Code` button, then copy the URL shown under "HTTPS" tab. -1.3. Open GitHub Desktop app. -1.4. Click on "File" in the menu bar, then select "Clone repository...". -1.5. In the popup, select the URL tab and paste the URL you just copied. Then, specify a local path where you want the files to be saved. -1.6. Click Clone. - -### Step 2: Open the project in Obsidian - -2.1. Open Obsidian. -2.2. If this is your first time using Obsidian, click on "Open folder as vault" on the welcome screen. If you've used Obsidian before, click on "File" -> "Open vault" first. -2.3. Select 'Open folder as vault' and then navigate to the local path where you cloned the GitHub repository, select `/content` folder inside of it, and click "Open". This will open all the markdown files in the repository in Obsidian's file explorer. - -### Step 3: Identify the markdown file you want to edit or add - -3.1. To edit an existing markdown file: navigate to the file you want to edit, and click it to open. -3.2. To add a new markdown file: click on the "New note" button (pencil icon) in Obsidian's left sidebar, name your file (e.g., `new-page.md`), and press Enter. You might need to move this file to the appropriate directory (pages or posts) later using your file explorer. - -### Step 4: Editing or adding content to your markdown file - -Some links here on editing on obsidian? - -- Another link on markdown formatting? - -Optional steps to test locally? I.e. npm install, npm run dev. - -### Step 5: Push your changes to the GitHub repository: - -5.1 Open your Github desktop app and select 'Add local repository' under 'File' -5.2 Select 'Choose...' and navigate to the folder of the cloned repository and click 'Open -5.3 Write a short summary, explaining the changes you've made -5.4 Press commit to main - -### Summary - -Congratulations, you've now learned how to edit or add Markdown-based pages locally on your computer! - -If anything is not clear to you, or you have suggestions on how we can make this 'How to' better, please don't hesitate to let us know. - -Happy editing! diff --git a/site/content/blog/edit-text-on-a-single-md-page.md b/site/content/blog/edit-text-on-a-single-md-page.md deleted file mode 100644 index b479a088..00000000 --- a/site/content/blog/edit-text-on-a-single-md-page.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: How to quickly edit text content on a single Markdown-based page -date: 2023-07-27 -authors: ['Ola Rubaj'] -filetype: 'blog' ---- - -Welcome to this tutorial on how to quickly edit text content on a single Markdown-based page. The steps here are designed for non-technical contributors. There's no need to know how to code! - -> [!important] -> This "How to" is only recommended for text changes only, e.g. those that don't include adding images, links to other pages, diagrams, or other elements that can't be previewed in GitHub preview mode. - -> [!tip] -> If you are unfamiliar with Markdown (and its different flavours and extra elements supported by Flowershow based websites), check out [this short guide](https://flowershow.app/docs/syntax) on available syntax elements. - -## Steps - -### Step 1: Navigate to the underlying Markdown file and edit it - -**Option A: Use the "Edit this page" button** - -If it was enabled, some pages on your website may have an "Edit this page" button at the bottom. By clicking it, you would be redirected to the corresponding Markdown file in your repository, ready for editing. - -**Option B: Locate the underlying Markdown file in the repository yourself** - -If the "Edit this page" button is unavailable, or if want to familiarise yourself more deeply with the repository's structure 💪, follow these steps: - -1. Go to the repository. -2. Click on the `content` folder to open it. This is where all the Markdown files for the website content are stored. -3. Navigate through the subfolders within the `content` folder to find the file corresponding to the page you wish to edit. - -> [!tip] -> To know exactly which file to look for, consider the URL of the web page you're trying to edit. The URL should correspond to the path of the file in the repository (excluding the `/content` prefix). E.g. a web page at `my.app.org/blog/welcome` will have its Markdown file located at `/content/blog/welcome.md`. -> If you can't find the corresponding markdown file in the repository, it may have been written in JSX instead of MD. For JSX you would need to know frontend programming, in which case submit an issue to your repository for the editing to be completed. - -4. Once you've found the correct file, click on it to see its contents. -5. Click on the pencil icon near the top right corner. This will open the file in edit mode. Now you can make your changes. -6. (Optionally) Switch to the "Preview" mode, by toggling from "Edit" -> "Preview" at the top of the file content, to see a rough visualisation of your changes. Keep in mind though, that the actual website may have different styling and may support additional Markdown elements that GitHub doesn't render on the preview. - -### Step 2: Save your changes - -When you're happy with the content, click on the “Commit changes...” button. In the "Commit message" field, provide a concise summary of your changes. If necessary, you can add further explanation in the "Extended description" text field. Then select “Commit directly to the main branch”, and hit "Commit changes." - -The site is now going to be rebuilt to reflect the changes saved to the `main` branch. This can take up to a few minutes. After this time you should see your page live. - -## Summary - -Congratulations! You've now learned how to edit the text content on a single Markdown-based page on your website. - -If anything is not clear to you, or you have suggestions on how we can make this 'How to' better, please don't hesitate to let us know. - -Happy editing! diff --git a/site/content/howtos/edit-or-add-md-pages-locally.md b/site/content/howtos/edit-or-add-md-pages-locally.md index c911c9b4..3856ad55 100644 --- a/site/content/howtos/edit-or-add-md-pages-locally.md +++ b/site/content/howtos/edit-or-add-md-pages-locally.md @@ -1,5 +1,8 @@ --- title: How to edit or add Markdown-based pages locally on your computer +date: 2023-07-27 +authors: ['Jake Hirsch', 'Ola Rubaj'] +filetype: 'blog' --- ## Intro diff --git a/site/content/howtos/edit-text-on-a-single-md-page.md b/site/content/howtos/edit-text-on-a-single-md-page.md index 407e484b..b479a088 100644 --- a/site/content/howtos/edit-text-on-a-single-md-page.md +++ b/site/content/howtos/edit-text-on-a-single-md-page.md @@ -1,13 +1,16 @@ --- title: How to quickly edit text content on a single Markdown-based page +date: 2023-07-27 +authors: ['Ola Rubaj'] +filetype: 'blog' --- -Welcome to this tutorial on how to quickly edit text content on a single Markdown-based page. The steps here are designed for non-technical contributors. There's no need to know how to code! +Welcome to this tutorial on how to quickly edit text content on a single Markdown-based page. The steps here are designed for non-technical contributors. There's no need to know how to code! > [!important] -> This "How to" is only recommended for text changes only, e.g. those that don't include adding images, links to other pages, diagrams, or other elements that can't be previewed in GitHub preview mode. +> This "How to" is only recommended for text changes only, e.g. those that don't include adding images, links to other pages, diagrams, or other elements that can't be previewed in GitHub preview mode. ->[!tip] +> [!tip] > If you are unfamiliar with Markdown (and its different flavours and extra elements supported by Flowershow based websites), check out [this short guide](https://flowershow.app/docs/syntax) on available syntax elements. ## Steps