Markdownbased repo content migration + adjustments

This commit is contained in:
Ola Rubaj
2023-07-28 15:40:44 +02:00
committed by GitHub
parent 989d0987c6
commit 30f7de04c7
12 changed files with 136 additions and 39 deletions

View File

@@ -1,14 +1,16 @@
---
showToc: false
showSidebar: false
title: "Markdown-based Websites Guide"
title: 'Markdown-based Websites Guide'
disableTitle: true
description: Create markdown-based websites and data portals, update it, add collaborators and discover markdown superpowers with Flowershow and PortalJS
---
<Hero title="Markdown-based Websites" subtitle="Create markdown-based website, update it, add collaborators and discover markdown superpowers" />
# Tutorial 1: Create a website from scratch using markdown and PortalJS
## Tutorials
### Tutorial 1: Create a website from scratch using markdown and PortalJS
In this tutorial we will walk you through creating an elegant, fully functional website written in simple markdown and published with PortalJS.
@@ -20,7 +22,7 @@ By the end of this tutorial you will:
Below is a screenshot of how the final website will look like:
![[tutorial-1-result.png]]
### Setup a sandbox website including live publishing
#### Setup a sandbox website including live publishing
- Prerequisites: sign up for GitHub and Vercel
- Navigate to [datopian/flowershow repository](https://github.com/datopian/flowershow)
@@ -28,14 +30,14 @@ Below is a screenshot of how the final website will look like:
- Let the site build on Vercel
- Visit the site! Yay! Your site is working! 🎉
### Now, let's edit the front page
#### Now, let's edit the front page
- Navigate to `content/index.md` file in the site repository
- Add some text to it
- Save and watch the site redeploy
- Visit the site! Yay! Your changes are live! 🎉
### Let's add a page: e.g. about page
#### Let's add a page: e.g. about page
- Navigate to the `content` folder in the site repository
- Add `about.md` file with some text
@@ -45,7 +47,7 @@ Below is a screenshot of how the final website will look like:
> [!tip]
> Read full tutorial [[create-a-website-from-scratch|here!]]
# Tutorial 2: Editing your site locally on your computer
### Tutorial 2: Editing your site locally on your computer
In this tutorial, we will walk you through the process of editing your Flowershow website locally on your computer.
@@ -61,20 +63,20 @@ Below is a screenshot of how the final website will look like:
![[tutorial-2-result.png]]
### Clone the repository to your computer
#### Clone the repository to your computer
- Setup GitHub Desktop app with your GitHub account
- Grab your site's repository URL
- Open GitHub Desktop app and clone the repository
- Yay! You have a copy of your website's repository on your computer! 🎉
### Now, let's edit in Obsidian
#### Now, let's edit in Obsidian
- Open the `/content` folder of the cloned repository in Obsidian
- Edit the home page and the about page
- Create a folder with the reviews of books you've read
### Commit your changes
#### Commit your changes
- Commit the changes in GitHub Desktop app
- Push the changes to the remote repository
@@ -83,3 +85,13 @@ Below is a screenshot of how the final website will look like:
> [!tip]
> Read full tutorial [[edit-a-website-locally|here!]]
## Howtos
- [[quickly-create-a-sandbox-website|How to quickly create a sandbox website]]
- [[edit-text-on-a-single-md-page|How to quickly edit text on a single Markdown-based page]]
- [[add-a-simple-md-page|How to add a simple Markdown page]]
- [[edit-or-add-md-pages-locally|How to edit or add Markdown-based pages locally on your computer]]
- [[how-to-add-images-to-a-md-page|How to add images to a Markdown-based page]]
- [[publish-obsidian-vault-to-github|How to push an Obsidian vault to a GitHub repository]]
- [[create-a-simple-catalog-of-anything|How to create a simple catalog of anything in Obsidian]]