|
1 | | -name: 'Notion2Github' |
| 1 | +name: Notion2Github |
2 | 2 | author: Younho Choo |
3 | | -description: 'Automatic syncronization from Notion to Github' |
| 3 | +description: Automatic syncronization from Notion to Github |
4 | 4 | branding: |
5 | 5 | icon: inbox |
6 | 6 | color: black |
7 | 7 | inputs: |
8 | 8 | database-url: |
9 | | - description: '' |
| 9 | + description: URL of the notion database to extract. |
10 | 10 | required: true |
11 | 11 |
|
12 | 12 | # export config |
13 | 13 | docs-directory: |
14 | | - description: '' |
| 14 | + description: Directory in which the notion page to extract will be stored. |
15 | 15 | required: false |
16 | 16 | recursive-export: |
17 | | - description: '' |
| 17 | + description: Whether or not to recursively export child page. |
18 | 18 | required: false |
19 | 19 | create-page-directory: |
20 | | - description: '' |
| 20 | + description: Whether or not to create subdirectory with page title. |
21 | 21 | required: false |
22 | 22 | add-metadata: |
23 | | - description: '' |
| 23 | + description: Whether or not to add metadata to content. |
24 | 24 | required: false |
25 | 25 | lower-pathname: |
26 | | - description: '' |
| 26 | + description: Whether or not to make pathname to lowercase. |
27 | 27 | required: false |
28 | 28 | lower-filename: |
29 | | - description: '' |
| 29 | + description: Whether or not to make pathname to uppercase. |
30 | 30 | required: false |
31 | 31 | line-break: |
32 | | - description: '' |
| 32 | + description: Whether or not to convert empty blocks of notion to line break tag(<br />). |
33 | 33 | required: false |
34 | 34 |
|
35 | 35 | # database-config |
36 | 36 | category-column-name: |
37 | | - description: '' |
| 37 | + description: > |
| 38 | + In the Notion database, you can categorize content by category with "Select" property. |
| 39 | + If you create a "Select" property in the Notion database and pass the name of the column, |
| 40 | + then folders will be created by category. |
38 | 41 | required: false |
39 | 42 | tags-column-name: |
40 | | - description: '' |
| 43 | + description: > |
| 44 | + In the Notion database, you can tag content with "Multi Select" property. (should set add_metadata to True.) |
| 45 | + If you create a "Multi Select" property in the Notion database and pass the name of the column, |
| 46 | + then meta data will be insterted to contents. |
41 | 47 | required: false |
42 | 48 | created-time-column-name: |
43 | | - description: '' |
| 49 | + description: > |
| 50 | + In the Notion database, you can manage created time of content with "Created Time" property. |
| 51 | + If you create a "Created Time" property in the Notion database and pass the name of the column, |
| 52 | + you can add created time to filename. |
44 | 53 | required: false |
45 | 54 | status-column-name: |
46 | | - description: '' |
| 55 | + description: > |
| 56 | + In the Notion database, you can manage the status of content with "Select" property. |
| 57 | + If you create a "Select" property in the Notion database and pass the name of the column, |
| 58 | + you can import contents in a specific state or change the status of the content. |
47 | 59 | required: false |
48 | 60 | current-status: |
49 | | - description: '' |
| 61 | + description: Status of content to import. Must be an option in the "status_column_name" column. |
50 | 62 | required: false |
51 | 63 | next-status: |
52 | | - description: '' |
| 64 | + description: Status of contents after content was imported. Must be an option in the "status_column_name" column. |
53 | 65 | required: false |
54 | 66 | filters: |
55 | | - description: '' |
| 67 | + description: Key, value pair of filter list to apply to the Notion database. |
56 | 68 | required: false |
57 | 69 |
|
58 | 70 | runs: |
59 | | - using: 'docker' |
60 | | - image: 'Dockerfile' |
| 71 | + using: "docker" |
| 72 | + image: "Dockerfile" |
61 | 73 | args: |
62 | 74 | - ${{ inputs.database-url }} |
63 | 75 | - --docs-directory |
|
0 commit comments