Add getting started note
This commit is contained in:
parent
5bf8bbe7a5
commit
1e9d5c3bdb
23
posts/Getting Started.md
Normal file
23
posts/Getting Started.md
Normal file
@ -0,0 +1,23 @@
|
||||
## Getting started
|
||||
### Run on your local machine
|
||||
|
||||
Steps to run it on your local machine:
|
||||
1. Clone this [Github repo](https://github.com/TuanManhCao/digital-garden)
|
||||
2. Install [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable) package manager
|
||||
3. Copy all of your **markdown** file (`.md` only) and folder to `/posts/` **except** `/posts/index.md` file
|
||||
4. Go to root folder of your project, run `yarn && yarn run dev`
|
||||
5. Open this link in your browser http://localhost:3000/
|
||||
|
||||
If you prefer video content have a look at my walk through video in here
|
||||
**Youtube**
|
||||
|
||||
### Publish to the internet
|
||||
|
||||
Setup environment (with Netlify)
|
||||
1. Create your Github account and clone [my repository](https://github.com/TuanManhCao/digital-garden)
|
||||
2. Create Netlify account and follow [this instruction](https://www.netlify.com/blog/2020/11/30/how-to-deploy-next.js-sites-to-netlify/)
|
||||
|
||||
|
||||
Your normal workflow for publishing content, after initial setup is:
|
||||
1. Simply writing your content in Obisidian (or your favourite Markdown editor)
|
||||
2. Commit your changes and Push it to your Github repo
|
Loading…
Reference in New Issue
Block a user