diff --git a/.github/workflows/notion2github.yml b/.github/workflows/notion2github.yml
index 75689aa..409c2b9 100644
--- a/.github/workflows/notion2github.yml
+++ b/.github/workflows/notion2github.yml
@@ -1,18 +1,22 @@
name: Notion2Github
on:
- schedule:
- - cron: "0 14 * * *"
+ push:
+ branches:
+ - 'test/**'
jobs:
- automatic-syncronization-from-notion-to-github:
+ auto-sync-from-notion-to-github:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Notion2Github
- uses: ./
+ uses: younho9/notion2github@main
with:
- database-url: "https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad"
+ database-url: 'https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad'
+ docs-directory: docs/test
+ # filter-prop: Category
+ # filter-value: Test
env:
NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
@@ -20,6 +24,6 @@ jobs:
uses: creyD/prettier_action@v3.1
with:
prettier_options: --write ./docs/**/*.md
- commit_message: "docs: Update docs (auto)"
+ commit_message: 'docs: Update docs (auto)'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
index 83a8931..5ca90b7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,171 @@
+
+
# Notion2Github
+
+[](https://github.com/marketplace/actions/notion2github)
+[](.github/workflows/notion2github.yml)
+[](https://github.com/younho9/notion2github/releases/tag/v1.0.1)
+[](./LICENSE)
+
+| [English](/README.md) | [한국어](/docs/README.ko.md) |
+
+**Automatic syncronization from Notion to Github**
+
+---
+
+> ⚠️ **NOTE:** Narkdown is dependent on [notion-py](https://github.com/jamalex/notion-py), the **_unofficial_** Notion API created by [Jamie Alexandre](https://github.com/jamalex).
+> It can not gurantee it will stay stable. If you need to use in production, I recommend waiting for their official release.
+
+---
+
+## Usage
+
+### Quick Start
+
+1. Go to `github.com/{your_id}/{your_repo}/settings/secrets/actions`
+
+2. Set `token_v2` of Notion to your repository secret.
+
+ 
+
+ [How To Find Your Notion v2 Token - Red Gregory](https://www.redgregory.com/notion/2020/6/15/9zuzav95gwzwewdu1dspweqbv481s5)
+
+ [Encrypted secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#using-encrypted-secrets-in-a-workflow)
+
+3. Create a workflow in `.github/workflows/**.yml` of your repository
+
+Here are examples.
+
+### Example Workflow
+
+#### Example 1 (run on push & pull request in main)
+
+```yaml
+name: Notion2Github
+on:
+ pull_request:
+ push:
+ branches:
+ - main
+jobs:
+ auto-sync-from-notion-to-github:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Notion2Github
+ uses: younho9/notion2github@v1.1.0
+ with:
+ database-url: 'https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad'
+ docs-directory: docs
+ env:
+ NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
+
+ - name: Format documents
+ uses: creyD/prettier_action@v3.1
+ with:
+ prettier_options: --write ./docs/**/*.md
+ commit_message: 'docs: Update docs (auto)'
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+#### Example 2 (scheduled)
+
+```yaml
+name: Notion2Github
+on:
+ schedule:
+ - cron: '0 14 * * *'
+jobs:
+ auto-sync-from-notion-to-github:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Notion2Github
+ uses: younho9/notion2github@v1.1.0
+ with:
+ database-url: 'https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad'
+ docs-directory: docs
+ env:
+ NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
+
+ - name: Format documents
+ uses: creyD/prettier_action@v3.1
+ with:
+ prettier_options: --write ./docs/**/*.md
+ commit_message: 'docs: Update docs (auto)'
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+> [Useful site for crontab setting](https://crontab.guru/)
+
+### Live examples
+
+- [younho9/narkdown](https://github.com/younho9/narkdown/blob/main/.github/workflows/notion2github.yml)
+
+- [younho9/TIL](https://github.com/younho9/til/blob/main/.github/workflows/notion2github.yml)
+
+## Database template page for test
+
+Here is an [database template page](https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad?v=be43c1c8dd644cfb9df9efd97d8af60a) for importing pages from the database. Move to that page, duplicate it, and test it.
+
+
+
+
+
+# Notion2Github
+
+[](https://github.com/marketplace/actions/notion2github)
+[](.github/workflows/notion2github.yml)
+[](https://github.com/younho9/notion2github/releases/tag/v1.0.1)
+[](./LICENSE)
+
+| [English](/README.md) | [한국어](/docs/README.ko.md) |
+
+**노션에서 깃헙으로의 자동 동기화**
+
+---
+
+> ⚠️ **유의사항:** Notion2Github은 [Jamie Alexandre](https://github.com/jamalex)이 만든 **_비공식_** 노션 API인 [notion-py](https://github.com/jamalex/notion-py) 프로젝트에 의존하고 있습니다. 공식 API가 아니기 때문에 안정적이지 않을 수 있습니다. 프로덕션 환경에서 사용하고자 한다면, 노션 공식 API 출시를 기다리는 것을 권장합니다.
+
+---
+
+## 사용법
+
+### 바로 시작하기
+
+1. `github.com/{your_id}/{your_repo}/settings/secrets/actions` 으로 이동합니다.
+
+1. 노션의 `token_v2` 를 레포지토리의 Secrets으로 설정합니다.
+
+ 
+
+ [How To Find Your Notion v2 Token - Red Gregory](https://www.redgregory.com/notion/2020/6/15/9zuzav95gwzwewdu1dspweqbv481s5)
+
+ [Encrypted secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets#using-encrypted-secrets-in-a-workflow)
+
+1. 레포지토리의 `.github/workflows/**.yml` 파일에 워크플로우를 생성합니다.
+
+몇 가지 예시입니다.
+
+### 워크플로우 예제
+
+#### 예제 1 (main 브랜치에 push & pull request 시에 실행)
+
+```yaml
+name: Notion2Github
+on:
+ pull_request:
+ push:
+ branches:
+ - main
+jobs:
+ auto-sync-from-notion-to-github:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Notion2Github
+ uses: younho9/notion2github@v1.1.0
+ with:
+ database-url: 'https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad'
+ docs-directory: docs
+ env:
+ NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
+
+ - name: Format documents
+ uses: creyD/prettier_action@v3.1
+ with:
+ prettier_options: --write ./docs/**/*.md
+ commit_message: 'docs: Update docs (auto)'
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+#### 예제 2 (정해진 시간에 실행)
+
+```yaml
+name: Notion2Github
+on:
+ schedule:
+ - cron: '0 14 * * *'
+jobs:
+ auto-sync-from-notion-to-github:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Notion2Github
+ uses: younho9/notion2github@v1.1.0
+ with:
+ database-url: 'https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad'
+ docs-directory: docs
+ env:
+ NOTION_TOKEN: ${{ secrets.NOTION_TOKEN }}
+
+ - name: Format documents
+ uses: creyD/prettier_action@v3.1
+ with:
+ prettier_options: --write ./docs/**/*.md
+ commit_message: 'docs: Update docs (auto)'
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+> [크론탭 설정에 유용한 사이트](https://crontab.guru/)
+
+### 실사용 예제
+
+- [younho9/narkdown](https://github.com/younho9/narkdown/blob/main/.github/workflows/notion2github.yml)
+
+- [younho9/TIL](https://github.com/younho9/til/blob/main/.github/workflows/notion2github.yml)
+
+## 테스트를 위한 데이터베이스 템플릿 페이지
+
+데이터베이스로부터 페이지들을 가져올 수 있는 [데이터베이스 템플릿 페이지](https://www.notion.so/acc3dfd0339e4cacb5baae8673fddfad?v=be43c1c8dd644cfb9df9efd97d8af60a)가 있습니다.
+
+페이지로 이동해서 복제하고 테스트해볼 수 있습니다.
+
+
+
+