Skip to content

Latest commit

 

History

History
85 lines (67 loc) · 2.8 KB

README.md

File metadata and controls

85 lines (67 loc) · 2.8 KB
Raw

📕 Community templates

A template capable of rendering markdown from a given template file.

Community templates are a way to use official releases of lowlighter/metrics while using templates from external repositories (owned or not).

📮 Using community templates

Use setup_community_templates option to specify additional external sources using following format:

user/repo@branch:template

These templates will be downloaded through git and will be usable by prefixing their name with an @.

Example: using my-theme template by downloading it from user/repo

- uses: lowlighter/metrics@latest
  with:
    template: "@my-theme"
    setup_community_templates: "user/repo@main:my-theme"

For security reasons, community templates will use the classic template template.mjs instead of their own. If you trust a community template, append +trust to it.

Example: using and trusting my-theme template by downloading it from user/repo

- uses: lowlighter/metrics@latest
  with:
    template: "@my-theme"
    setup_community_templates: "user/repo@main:my-theme+trust"

⚠️ Note that it basically allow remote code execution and the template may have access to sensitive data along with tokens! Use this feature only from a trusted source. Remember that its content may also change at any time...

📪 Creating community templates

To create a new template, start a new repository and create a new folder in /source/templates with the same file structure as in lowlighter/metrics templates:

  • /source/templates
    • {template-name}
      • README.md,
      • metadata.yml,
      • image.svg
      • partials/
        • _.json
        • *.ejs

Then use HTML, CSS, and EJS to create something awesome! Do not hesitate to share it on GitHub discussions!

For more information, see contribution guide.

ℹ️ Examples workflows

name: Using a community template
uses: lowlighter/metrics@latest
with:
  token: ${{ secrets.METRICS_TOKEN }}
  template: '@classic'
  setup_community_templates: lowlighter/metrics@master:classic

name: Using a trusted community template
uses: lowlighter/metrics@latest
with:
  token: ${{ secrets.METRICS_TOKEN }}
  template: '@terminal'
  setup_community_templates: lowlighter/metrics@master:terminal+trust