Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

auto-doc: Updated README.md #7

Merged
merged 1 commit into from
May 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 24 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,39 +21,49 @@ Generating resumes with JSONResume! Makes use of the `resumed` CLI to generate r
- uses: Devleaps/jsonresume-generator@v1
id: jsonresume-generator
with:
# Action to perform. Can be either `render` or `validate`.
# Action to perform. Can be
# either `render` or `validate`.
# Type: string
# Default: "render"
action: ''

# Name of the resume file. Support for JSON and
# YAML files.
# Name of the resume file.
# Support for JSON and YAML
# files.
# Type: string
# Default: "resume.json"
file: ''

# Name of the folder where the resume file is
# located. Can also be a wildcard (e.g. resumes/**). The file
# name is still required and expected to be the
# same for all files.
# Name of the folder where
# the resume file is located.
# Can also be a wildcard
# (e.g. resumes/**). The file name is
# still required and expected to
# be the same for all
# files.
# Type: string
folder: ''

# Type of the output file. Can be either PDF
# or HTML.
# Type of the output file.
# Can be either PDF or
# HTML.
# Type: string
# Default: "html"
output-type: ''

# Where the theme is located. Can be either local
# or npm. If true, the theme is expected to
# be in a folder with the theme-name. If false,
# the theme will be installed through NPM.
# Where the theme is located.
# Can be either local or
# npm. If true, the theme
# is expected to be in
# a folder with the theme-name.
# If false, the theme will
# be installed through NPM.
# Type: boolean
# Default: "false"
theme-local: ''

# Name of the theme to use.
# Name of the theme to
# use.
# Type: string
# Default: "jsonresume-theme-even"
theme-name: ''
Expand Down