docs(plugins): clarification, fix typos and style
This commit is contained in:
@@ -1,6 +1,9 @@
|
||||
name: "🗂️ Active projects"
|
||||
name: 🗂️ GitHub projects
|
||||
category: github
|
||||
description: This plugin displays progress of your profile and repository projects.
|
||||
description: |
|
||||
This plugin displays progress of profile and repository projects.
|
||||
|
||||
> ℹ️ This plugin currently only supports [GitHub projects boards](https://docs.github.com/en/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) and not [GitHub projects (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects)
|
||||
examples:
|
||||
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.projects.svg
|
||||
index: 11
|
||||
@@ -14,7 +17,8 @@ scopes:
|
||||
inputs:
|
||||
|
||||
plugin_projects:
|
||||
description: Enable projects plugin
|
||||
description: |
|
||||
Enable projects plugin
|
||||
type: boolean
|
||||
default: no
|
||||
|
||||
@@ -22,7 +26,7 @@ inputs:
|
||||
description: |
|
||||
Display limit
|
||||
|
||||
Note that `plugin_projects_repositories` is not affected by this option
|
||||
Projects defined by [`plugin_projects_repositories`](/source/plugins/projects/README.md#plugin_projects_repositories) are not affected by this option
|
||||
type: number
|
||||
default: 4
|
||||
min: 0
|
||||
@@ -30,7 +34,7 @@ inputs:
|
||||
|
||||
plugin_projects_repositories:
|
||||
description: |
|
||||
List of repositories projects
|
||||
Featured repositories projects
|
||||
|
||||
Use the following syntax for each project `:user/:repo/projects/:project_id`
|
||||
type: array
|
||||
@@ -40,6 +44,7 @@ inputs:
|
||||
preset: no
|
||||
|
||||
plugin_projects_descriptions:
|
||||
description: Toggle projects descriptions display
|
||||
description: |
|
||||
Projects descriptions
|
||||
type: boolean
|
||||
default: no
|
||||
|
||||
Reference in New Issue
Block a user