knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[guide/index.md][xs]: headings adjstmts

Browse Source
This commit is contained in:
Ola Rubaj 2023-07-28 15:35:18 +02:00
parent a997a956b5
commit a580c2dc0a
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
site/content/guide/index.md
View File

@ -1,13 +1,15 @@
--- ---
showToc: false showToc: false
showSidebar: false showSidebar: false
title: "Markdown-based Websites Guide" title: 'Markdown-based Websites Guide'
disableTitle: true disableTitle: true
--- ---
<Hero title="Markdown-based Websites" subtitle="Create markdown-based website, update it, add collaborators and discover markdown superpowers" /> <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. In this tutorial we will walk you through creating an elegant, fully functional website written in simple markdown and published with PortalJS.
@ -19,7 +21,7 @@ By the end of this tutorial you will:
Below is a screenshot of how the final website will look like: Below is a screenshot of how the final website will look like:
![[tutorial-1-result.png]] ![[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 - Prerequisites: sign up for GitHub and Vercel
- Navigate to [datopian/flowershow repository](https://github.com/datopian/flowershow) - Navigate to [datopian/flowershow repository](https://github.com/datopian/flowershow)
@ -27,14 +29,14 @@ Below is a screenshot of how the final website will look like:
- Let the site build on Vercel - Let the site build on Vercel
- Visit the site! Yay! Your site is working! 🎉 - 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 - Navigate to `content/index.md` file in the site repository
- Add some text to it - Add some text to it
- Save and watch the site redeploy - Save and watch the site redeploy
- Visit the site! Yay! Your changes are live! 🎉 - 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 - Navigate to the `content` folder in the site repository
- Add `about.md` file with some text - Add `about.md` file with some text
@ -44,7 +46,7 @@ Below is a screenshot of how the final website will look like:
> [!tip] > [!tip]
> Read full tutorial [[create-a-website-from-scratch|here!]] > 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. In this tutorial, we will walk you through the process of editing your Flowershow website locally on your computer.
@ -60,20 +62,20 @@ Below is a screenshot of how the final website will look like:
![[tutorial-2-result.png]] ![[tutorial-2-result.png]]
### Clone the repository to your computer #### Clone the repository to your computer
- Setup GitHub Desktop app with your GitHub account - Setup GitHub Desktop app with your GitHub account
- Grab your site's repository URL - Grab your site's repository URL
- Open GitHub Desktop app and clone the repository - Open GitHub Desktop app and clone the repository
- Yay! You have a copy of your website's repository on your computer! 🎉 - 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 - Open the `/content` folder of the cloned repository in Obsidian
- Edit the home page and the about page - Edit the home page and the about page
- Create a folder with the reviews of books you've read - Create a folder with the reviews of books you've read
### Commit your changes #### Commit your changes
- Commit the changes in GitHub Desktop app - Commit the changes in GitHub Desktop app
- Push the changes to the remote repository - Push the changes to the remote repository