add action-option doc

README.md

@@ -23,7 +23,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: drmingdrmer/md2zhihu@v0.2
+    - uses: drmingdrmer/md2zhihu@v0.4
       env:
         GITHUB_USERNAME: ${{ github.repository_owner }}
         GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
@@ -44,6 +44,46 @@ or access the branch on the web:
 https://github.com/drmingdrmer/drmingdrmer.github.io/blob/_md2zhihu/md/_md2zhihu/dict-cmp.md
 
 
+### Options
+
+-   `pattern`:
+
+    file pattern to convert
+
+    **required**: True
+    **default**: `**/*.md`
+
+-   `output_dir`:
+
+    dir to store converted markdown
+
+    **required**: True
+    **default**: `_md2zhihu`
+
+-   `md_branch`:
+
+    The branch name to push converted markdown to. A build overrides previous built branch. If you want to persist the built markdowns, merge this branch.
+
+    **required**: True
+    **default**: `_md2zhihu/md`
+
+-   `asset_branch`:
+
+    The branch name in which assets are stored.
+
+    **required**: True
+    **default**: `_md2zhihu/asset`
+
+-   `target_platform`:
+
+    The platform that the converted markdown should be compatible to.
+Currently supported platforms are zhihu, wechat, weibo, simple. `simple` converts almost everything to images and removes most text styles. E.g. inline code block is converted to normal text.
+
+    **required**: True
+    **default**: `zhihu`
+
+
+
 ## Use it Locally
 
 System requirement: MaxOS

action-doc.md

@@ -0,0 +1,36 @@
+-   `pattern`:
+
+    file pattern to convert
+
+    **required**: True
+    **default**: `**/*.md`
+
+-   `output_dir`:
+
+    dir to store converted markdown
+
+    **required**: True
+    **default**: `_md2zhihu`
+
+-   `md_branch`:
+
+    The branch name to push converted markdown to. A build overrides previous built branch. If you want to persist the built markdowns, merge this branch.
+
+    **required**: True
+    **default**: `_md2zhihu/md`
+
+-   `asset_branch`:
+
+    The branch name in which assets are stored.
+
+    **required**: True
+    **default**: `_md2zhihu/asset`
+
+-   `target_platform`:
+
+    The platform that the converted markdown should be compatible to.
+Currently supported platforms are zhihu, wechat, weibo, simple. `simple` converts almost everything to images and removes most text styles. E.g. inline code block is converted to normal text.
+
+    **required**: True
+    **default**: `zhihu`
+

action.yml

@@ -8,7 +8,7 @@ inputs:
   pattern:
     description: 'file pattern to convert'
     required: true
-    default: '*.md'
+    default: '**/*.md'
 
   output_dir:
     description: 'dir to store converted markdown'

make-action-doc.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+import yaml
+
+with open("action.yml", 'r') as f:
+    cont = f.read()
+
+y = yaml.load(cont)
+
+with open("action-doc.md", 'w') as f:
+
+    for k, v in y['inputs'].items():
+        f.write("-   `{k}`:".format(k=k))
+        f.write("\n")
+        f.write("\n")
+        f.write("    {description}\n".format(description=v['description'].strip()))
+        f.write("\n")
+        f.write("    **required**: {required}\n    **default**: `{default}`".format(**v))
+        f.write("\n")
+        f.write("\n")

version.py

@@ -1,2 +1,2 @@
-__version__ = "0.1.26"
+__version__ = "0.4"
 __name__ = "md2zhihu"