{"id":15065882,"url":"https://github.com/itamarc/action-itemplate-ghpages","last_synced_at":"2026-01-02T12:58:25.941Z","repository":{"id":65160201,"uuid":"379739228","full_name":"itamarc/action-itemplate-ghpages","owner":"itamarc","description":"Action to publish GitHub Pages automatically using themes or custom templates (using ITemplate)","archived":false,"fork":false,"pushed_at":"2021-09-24T03:49:41.000Z","size":2348,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-03T17:46:37.997Z","etag":null,"topics":["docker","gfm","github","github-actions","github-pages","graphql-client","java","markdown"],"latest_commit_sha":null,"homepage":"https://itamarc.github.io/action-itemplate-ghpages/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itamarc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-23T22:02:31.000Z","updated_at":"2021-09-21T20:27:58.000Z","dependencies_parsed_at":"2023-01-13T15:43:47.337Z","dependency_job_id":null,"html_url":"https://github.com/itamarc/action-itemplate-ghpages","commit_stats":{"total_commits":124,"total_committers":1,"mean_commits":124.0,"dds":0.0,"last_synced_commit":"28eab84adc7d5e19aac01ac4b64856a3fc1d3344"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itamarc%2Faction-itemplate-ghpages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itamarc%2Faction-itemplate-ghpages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itamarc%2Faction-itemplate-ghpages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itamarc%2Faction-itemplate-ghpages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itamarc","download_url":"https://codeload.github.com/itamarc/action-itemplate-ghpages/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809887,"owners_count":20351407,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","gfm","github","github-actions","github-pages","graphql-client","java","markdown"],"created_at":"2024-09-25T00:56:46.551Z","updated_at":"2026-01-02T12:58:25.908Z","avatar_url":"https://github.com/itamarc.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action: action-itemplate-ghpages\n\nThis action can automatically publish auto-filled GitHub Pages using basic data\nfrom your repository.\n\nIt can be used with some pre-build themes or you can customize the generated\npages with your own custom templates (using\n[ITemplate](https://itamarc.github.io/itemplate/)).\n\n## GitHub Pages\n\nGitHub Pages can be stored on any branch and in the root folder or in `/docs` folder.\nThis action supports all of these options, but it is recommended to use the\n`gh-pages` branch and `/docs` folder.\n\n## Simple usage: themes\n\nThis action have some pre-build **[Themes](Themes.md)** that can be used. This is the simplest way to use it.\n\nTo use a theme, in the `templates_folder` input (see the section **[Simple Workflow Using a Theme](#simple-workflow-using-a-theme)**\nbelow), you put only the name of the theme you want to use enclosed by \":\".\n\nFor example: to use the 'light' theme, you need to set:\n\n    templates_folder: ':light:'\n\nAvailable themes are:\n- `:reference:`\n- `:light:`\n- `:dark:`\n- `:bluish:`\n- `:greenish:`\n- `:purplish:`\n- `:grayish:`\n- `:hellish:`\n- `:greenscreen:`\n\n(You can see a screenshot of the themes in the [Themes](Themes.md) page).\n\n### Configuration\n\nThe recomended configuration for your GitHub Pages:\n- create a branch named `gh-pages` for your pages\n- configure your pages in the `gh-pages` branch (Repository Settings \u003e Pages \u003e Source)\n- point your pages to the `docs` folder in the settings\n\nTo avoid the Jekyll processing of your GitHub Pages, you need to create an\nempty file named `.nojekyll` in the root of your pages folder.\nIf you followed the recomendations above, it needs to be in `docs/.nojekyll` at\nthe `gh-pages` branch.\n\n### Simple Workflow Using a Theme\n\nYou need to create a workflow in your repository Actions to use this action,\nlike this one:\n\n```yaml\nname: Automatic GitHub Pages generation\n\non:\n  # Trigger on page_build, as well as release, fork, push, watch and issues events\n  page_build:\n  release:\n  fork:\n  push:\n  watch:\n  issues:\n    types:\n      - opened\n      - closed\n      - edited\n      - deleted\njobs:\n  deploy-pages:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v2\n      with:\n        # The branch where the templates are stored\n        # (if not present, uses the 'master' branch)\n        # (recomended: use the same branch configured to be used in GH Pages)\n        ref: 'gh-pages'\n    - uses: itamarc/action-itemplate-ghpages@v1\n      with:\n        templates_folder: ':light:'\n        pages_branch: 'gh-pages'\n        pages_folder: 'docs'\n        # Change to your time zone\n        timezone: 'America/Sao_Paulo'\n      env:\n        # Needed to publish the pages\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n(More details about these inputs in the workflow and others are below in the\n[**Action Inputs**](#action-inputs) section)\n\n### Optional features\n\nIf you want to publish your `README.md` file, you need to enable the\n`publish_readme_md` option. If set to 'true', the action will publish the\n`README.md` file from the repository root in the generated page as\n`README.html` and put a link to it in the generated page.\nIf set to 'inline', the `README.md` file will be included in the\ngenerated `index.html` file.\n\nIf you want to publish some additional content, you need to add them to the\n`content_to_copy` option. This can be used, for example, to copy images\nreferenced in the `README.md` file. If this content includes other Markdown\nfiles, you may want to set the `convert_md_to_html` option to 'true' to not\nonly convert the files but also convert the links to them from \".md\" to\n\".html\", in all these files and in the `README.html` file as well.\n\nYou can also want to automatically copy the `README.md` file from the `master`\nbranch to the `gh-pages` branch. To do that, see the [**Tips**](#tips) section below.\n\n## Advanced usage: custom templates\n\nYou can create your own templates and use them with this action.\n\n*Suggestion:* you can copy a pre-built theme you want to use and modify it.\nIn the action repository, you can find the pre-built themes in the `themes`\nfolder. Look at the folder with the name of the theme you want to use and also\nthe files in `common` folder.\n\n### Configuration\n\nThe recomended configuration for your GitHub Pages:\n- put your templates and your pages in a branch of their own (for example: `gh-pages`)\n- point your pages to the `docs` folder in the settings\n- put your templates in a folder outside the `docs` folder (for example: `templates`)\n- if you want to use snippets, put them in a separate folder (for example: `snippets`)\n\nTo avoid the Jekyll processing of your GitHub Pages, you need to create an empty file named `.nojekyll` in the root of your pages folder.\nIf you followed the recomendations above, it will be in `docs/.nojekyll`.\n\n### Action Inputs\n\nThis action can be configured with the following inputs:\n\n| Input Name | Required | Description |\n| --- | --- | --- |\n| `templates_folder` | Yes | The relative path to the folder that contains your site's templates or the identification of the theme you want to use |\n| `allow_templates_subfolders` | No | Allow the templates to be stored in subfolders under templates_folder. The output folders tree will map the input. (default: `false`) |\n| `snippets_folder` | No | The relative path to the folder that contains your site's snippets, if any. If this is set and allow_templates_subfolders is true, can't be inside de templates tree. |\n| `pages_branch` | Yes | The branch name for storing github pages |\n| `pages_folder` | Yes | The name of the output folder where generated html will be stored |\n| `timezone` | Yes | The time zone to calculate the update time |\n| `max_issues` | No | The max number of issues that will be retrieved and shown (0-100, default: '5') |\n| `max_collaborators` | No | The max number of collaborators that will be retrieved and shown (0-100, default '20') |\n| `publish_readme_md` | No | Publish the README.md from the repository root in the generated page as README.html (default `false`). The themes will automatically insert a link to the README.html file in the index.html file if this option is set to 'true'. If this option is set to 'inline', the README.html file will be included in the generated index.html file. |\n| `content_to_copy` | No | Folders or files to copy when publishing, keeping the relative path, separated by spaces. These files will be copied to the output folder without any change, except if `convert_md_to_html` is set to `true`. (default '' - meaning none) |\n| `convert_md_to_html` | No | Convert Markdown files pointed by 'content_to_copy' to HTML, changing also the links to them on all Markdown files, including `README.md`. Markdown files in the templates and snippets folders will always be converted to HTML. (default: 'false') |\n| `syntax_highlight_enable` | No | Enable syntax highlight of code tags with class 'language-*', like some markdown converted files. Not all languages supported in Prism.js are enabled. If you want to use a language supported by Prism.js not present in this action, open an issue that I can add it. (default: `false`) |\n| `syntax_highlight_theme` | No | Syntax highlight theme from Prism.js. Valid values: default, coy, dark, funky, okaidia, solarizedlight, tomorrow, twilight. (default: `default`) |\n| `log_level` | No | The log level, according to the ones defined in java.util.logging.Level. (default: `WARNING`) |\n\n### Full Workflow\n\nTo use the action, you need to create a workflow like the one below.\nThe checkout step is required to the action to have access to your templates\nand to be able to commit back the changed pages.\n\n```yaml\nname: Automatic GitHub Pages generation\n\non:\n  # Trigger on page_build, as well as release, fork, push, watch and issues events\n  page_build:\n  release:\n  fork:\n  push:\n  watch:\n  issues:\n    types:\n      - opened\n      - closed\n      - edited\n      - deleted\njobs:\n  deploy-pages:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v2\n      with:\n        # The branch where the templates are stored\n        # (if not present, uses the 'master' branch)\n        # (recomended: use the same branch configured to be used in GH Pages)\n        ref: 'gh-pages'\n    - uses: itamarc/action-itemplate-ghpages@v1\n      with:\n        templates_folder: 'templates'\n        allow_templates_subfolders: 'false'\n        snippets_folder: 'snippets'\n        pages_branch: 'gh-pages'\n        pages_folder: 'docs'\n        # Change to your time zone\n        timezone: 'America/Sao_Paulo'\n        max_issues: '5'\n        max_collaborators: '20'\n        publish_readme_md: 'true'\n        content_to_copy: ''\n        syntax_highlight_enable: 'true'\n        syntax_highlight_theme: 'default'\n        log_level: 'INFO'\n      env:\n        # Needed to publish the pages\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### Template files\n\nThe templates are in the format supported by [ITemplate](https://itamarc.github.io/itemplate/).\n\nIf your template files have the sequence \".tmpl\" in the name, it will be removed.\nFor example, if you have a template file called `index.tmpl.html`, the\nresulting file will have the name `index.html`.\nOtherwise, the name is not changed.\n\n#### Snippets\n\nIf the parameter `snippets_foler` is set, the files in this folder will be\nprocessed first and their filled content will be available to the templates using as \nkey the file name until the first character \".\" (dot) preceded by `SNP_`.\n\nExample: if there is in the snippets folder a file named `RELEASES.html`\n(or `RELEASES.tmpl.html` or `RELEASES.snp.html`), it will be processed\nand its content will be available when processing the templates with the\nkey `SNP_RELEASES`.\n\nThe snippets folder will not be recursive, all snippets must be in the same\nfolder, without subfolders.\n\nSnippets will not be saved in any way to the destination folder.\n\n#### Markdown\n\nIf you have a template or snippet with extension `.md`, it will:\n1. Be filled using ITemplate\n2. Be converted to HTML\n3. If it's a template, be saved in the destination with `.html` extension instead of `.md`\n\nIf it's a template, the resulting HTML file will be completed with header and footer\n(the footer will be only `\u003c/body\u003e\u003c/html\u003e`).\n\nIf you're using a built-in theme, it will use the theme's CSS.\n\nIf you're using a custom set of templates and you want a custom header for your\nMarkdown files (for example, to define a specific CSS), create a snippet with\nname `MARKDOWN_HEADER` (it will be used internally using the key\n`SNP_MARKDOWN_HEADER` and will be available to be used in the templates).\nInclude in this file everything that you want including a `\u003cbody\u003e` tag.\n\n### Publishing the `README.md`\n\nYou can export the `README.md` file from **your GitHub Pages branch** (be\ncareful to don't edit only the one in `master` or `main` branch, unless this\nis the source for your Pages - ***not recommended***) using the action\nparameter `publish_readme_md`.\n\nThis parameter can have the following values:\n- `true`: the `README.md` will be converted and published as a separate file `README.html`.\n  If you're using a built-in theme, the generated page will have a link to it.\n- `inline`: the `README.md` will be exported available as a snippet with key `SNP_README`.\n  If you're using a built-in theme, the content will be included in the generated page.\n- `false`: the `README.md` will not be published\n\nIf set to `true`, it will be completed with header and footer as described in\n**Markdown** section. If you want a custom header, you can use the\n`MARKDOWN_HEADER` snippet or an specific one with the name `README_HEADER`\n(this last one will have precedence if it exists).\n\nTo automatically copy the `README.md` file from the `master` branch to your\npages branch, you can use the `planetoftheweb/copy-to-branches` action.\nSee the [**Tips**](#tips) section below for details.\n\n### Syntax Highlight\n\nWhen converting a Markdown file to HTML, the code blocks will be \nconverted to HTML tag `\u003cpre\u003e\u003ccode class=\"language-xxx\"\u003e...\u003c/code\u003e\u003c/pre\u003e`\nwhere `xxx` is the language name defined in the Markdown code block.\n\nYou can use this also in your custom templates. If you're using your own\ntemplates and have the syntax highlight enabled, the following snippets will be\navailable for you to insert the code needed:\n`SNP_SYNTAX_HIGHLIGHT_CSS` to your `\u003chead\u003e` section and\n`SNP_SYNTAX_HIGHLIGHT_JS` in the end of your `\u003cbody\u003e` section.\nThe appropriate CSS and JS files will be copied automatically.\n\nTo enable the syntax highlight for these code blocks, you need to set the\ninput `syntax_highlight_enable` to `true`.\n\nIf you want to use a theme different from `default`, you need to set the\ninput `syntax_highlight_theme` to the name of the theme you want to use.\n\nThe following themes from PrismJS are supported: default, coy, dark, funky,\nokaidia, solarizedlight, tomorrow, twilight.\n\nThe following languages are supported in this Action:\nMarkup, Clike, Javascript, Actionscript, Apacheconf, Sql, Applescript, C, Arduino, Autohotkey, Autoit, Basic, Batch, Bbcode/shortcode, Csharp/dotnet/cs, Cmake, Cobol, Csv, Lua, Erlang, Excel-formula/xls, Fortran, Git, Graphql, Ini, Javastacktrace, Json, Jsonp, Jsstacktrace, Julia, Log, Makefile, Matlab, Objectivec, Pascal/objectpascal, Perl, Php, Powershell, Properties, Python, R, Rest, Scala, Iecst, Swift, Vbnet, Vim, Visual-basic/vba, Wolfram/mathematica/wl/nb.\n\nI didn't insert all languages from PrismJS to avoid the overhead in the JS file size.\n\nIf you need to add a new language supported by PrismJS, you can open an Issue and I'll add it ASAP.\n\n### Publishing additional content\n\nIf you set the `content_to_copy` parameter, the files or folders specified\nwill be copied when publishing, keeping the relative path, without change.\n\nThis input parameter needs to have the relative path to the files or folders\nyou want to copy separated by spaces.\n\nFor example, if you want to copy the `images` folder and the `help.html` file\nfrom the `www` folder, you can set the parameter as:\n\n    content_to_copy: 'images www/help.html'\n\n### Available data\n\nThe templates and the snippets can use any of the keys in the next sections.\n\n#### From the GitHub API\n\nKey | Description | Example\n----|-------------|--------\nrepository_name | Repository name | myrepository\nrepository_nameWithOwner | Repository name with owner | mylogin/myrepository\nrepository_description | Description of the repository | Repository to test GitHub functionality.\nrepository_shortDescriptionHTML | The short description of the repository | Repository to test GitHub functionality.\nrepository_createdAt | Repository creation date | 2021-06-13T19:54:12Z\nrepository_updatedAt | Last time the repository was updated | 2021-07-04T02:17:15Z\nrepository_url | Repository's URL | https://github.com/mylogin/myrepository\nrepository_homepageUrl | If it's configured, the homepage URL for this repository | https://itamarc.github.io/githubtest/\nrepository_forkCount | How many times this repository was forked | 2\nrepository_stargazerCount | How many times the repository was starred? | 1000\nrepository_watchers_totalCount | How many users are whatching the repository | 1234\nrepository_repositoryTopics | The topics of the repository | [{\"name\":\"java\",\"url\":\"https://github.com/topics/java\"},\u003cbr\u003e{\"name\":\"text\",\"url\":\"https://github.com/topics/text\"},\u003cbr\u003e{\"name\":\"templates\",\"url\":\"https://github.com/topics/templates\"},\u003cbr\u003e{\"name\":\"library\",\"url\":\"https://github.com/topics/library\"}]\nrepository_collaborators | Data of the colaborators of the repository | [{\"name\":\"John Constantine\",\"login\":\"mylogin\",\"url\":\"https://github.com/mylogin\"}]\nrepository_issues | Last 5 issues (max) with general data | [{\"number\":\"7\",\"createdAt\":\"2021-06-29T23:11:19Z\",\"comments_totalCount\":0},\"author\":{\"login\":\"mylogin\",\"url\":\"https://github.com/mylogin\"},\"titleHTML\":\"Support file format ABC\",\"url\":\"https://github.com/mylogin/myrepository/issues/7\"},\u003cbr\u003e{\"number\":\"8\",\"createdAt\":\"2021-06-30T21:37:25Z\",\"comments_totalCount\":0},\"author\":{\"login\":\"mylogin\",\"url\":\"https://github.com/mylogin\"},\"titleHTML\":\"NullPointerException in class Aaaaa\",\"url\":\"https://github.com/mylogin/myrepository/issues/8\"},\u003cbr\u003e{\"number\":\"9\",\"createdAt\":\"2021-07-01T03:37:28Z\",\"comments_totalCount\":0},\"author\":{\"login\":\"mylogin\",\"url\":\"https://github.com/mylogin\"},\"titleHTML\":\"Describe the API in the documentation\",\"url\":\"https://github.com/mylogin/myrepository/issues/9\"}]\nrepository_languages | Programming languages present in the repository with the respective sizes | [{\"color\":\"#384d54\",\"size\":640,\"name\":\"Dockerfile\"},\u003cbr\u003e{\"color\":\"#b07219\",\"size\":18636,\"name\":\"Java\"},\u003cbr\u003e{\"color\":\"#89e051\",\"size\":661,\"name\":\"Shell\"}]\nrepository_languages_totalSize | Total size of the artifacts in the repository | 19937\nrepository_latestRelease_name | Name of the last release in the repository | New version with more features\nrepository_latestRelease_description | Description of the last release in the repository. If the description have multiple lines, the lines will be separated by `\u003cbr\u003e` and put in a single line. | This is version v2 of the software, with the new features X, Y and Z and with bug fixes #1, #2 and #3.\nrepository_latestRelease_author_login | Login of the author of the last release in the repository | mylogin\nrepository_latestRelease_author_name | Name of the author of the last release in the repository | John Constantine\nrepository_latestRelease_createdAt | Creation date of the last release in the repository | 2021-06-23T15:14:16Z\nrepository_latestRelease_isPrerelease | Is the last release in the repository a pre-release? | false\nrepository_latestRelease_tagName | Tag name of the last release in the repository | v1.2\nrepository_latestRelease_url | URL for the last release in the repository | https://github.com/itamarc/itemplate/releases/tag/v1.2\nrepository_licenseInfo_conditions | Conditions of the repository's licence | [\"License and copyright notice\",\"State changes\",\"Disclose source\",\"Same license\"]\nrepository_licenseInfo_name | Name of the repository's licence | GNU General Public License v3.0\nrepository_licenseInfo_nickname | Nickname of the repository's licence | GNU GPLv3\nrepository_licenseInfo_url | URL for the repository's licence text | http://choosealicense.com/licenses/gpl-3.0/\nrepository_owner_avatarUrl | URL for the repository's owner avatar | https://avatars.githubusercontent.com/u/00010001?u=aaaabbbbcccc111122223333\u0026v=4\nrepository_owner_login | Repository's owner login | ownerlogin\nrepository_owner_url | Repository's owner URL | https://github.com/mylogin\n\n#### Calculated\n\nKey | Description | Example\n----|-------------|--------\nTMPL_LASTUPDATE | Date and time in ISO format of the action current run | 2021-06-27 18:02:03 GMT-03:00\n\n#### From the parameters\n\nThose keys are the parameters you passed to the action, and you can find an utility for them in your templates.\n\nKey | Description | Example\n----|-------------|--------\nINPUT_TEMPLATES_FOLDER | The folder where the templates are or the theme id | 'templates' or ':light:'\nINPUT_ALLOW_TEMPLATES_SUBFOLDERS | Allow the templates to be stored in subfolders under templates_folder | 'false'\nINPUT_SNIPPETS_FOLDER | The folder where the snippets are | 'snippets'\nINPUT_PAGES_BRANCH | The branch configured as the source for your GitHub Pages | 'gh-pages'\nINPUT_PAGES_FOLDER | The folder configured as the source for your GitHub Pages | 'docs'\nINPUT_TIMEZONE | The timezone ID that will be used to calculate TMPL_LASTUPDATE | 'America/Sao_Paulo'\nINPUT_MAX_ISSUES | The maximum number of issues to be retrieved | 5\nINPUT_MAX_COLLABORATORS | The maximum number of collaborators to be retrieved | 20\nINPUT_PUBLISH_README_MD | Publish the README.md from the repository root in the generated page as README.html | 'true'\nINPUT_CONTENT_TO_COPY | List of content (files or folders) to copy from the repository to the generated page, separated by space | 'images LICENSE.txt'\nINPUT_CONVERT_MD_TO_HTML | Convert Markdown files in `content_to_copy` to HTML and change the links accordingly | 'true'\nINPUT_SYNTAX_HIGHLIGHT_ENABLE | Enable the syntax highlighting in the generated page | 'true'\nINPUT_SYNTAX_HIGHLIGHT_THEME | The theme to use for the syntax highlighting (from PrismJS) | 'tomorrow'\nINPUT_LOG_LEVEL | The log level that will be used to log the action execution | 'INFO'\n\n#### From the environment\n\nThose keys are mostly for the use of the action itself, but since it's there, maybe you can use them somehow.\n\nKey | Description | Example\n----|-------------|--------\nGITHUB_WORKSPACE | The workspace where your code is, obtained with action/checkout | /github/workspace\nGITHUB_EVENT_PATH | The path of the file with the complete webhook event payload. | /github/workflow/event.json\nGITHUB_GRAPHQL_URL | The URL to the GitHub GraphQL API | https://api.github.com/graphql\nGITHUB_SERVER_URL | The URL to the GitHub site | https://github.com\nGITHUB_REPOSITORY_OWNER | The owner of the repository | itamarc\nGITHUB_REPOSITORY | The owner and repository name. | itamarc/githubtest\nGITHUB_ACTOR | The name of the person or app that initiated the workflow. | itamarc\nGITHUB_REF | The branch or tag ref that triggered the workflow. | refs/heads/master\n\n## Tips\n\n* If you're maintaing your Pages in the 'gh-pages' branch, you can use the\n[planetoftheweb/copy-to-branches](https://github.com/marketplace/actions/copy-to-branches-action)\naction to copy your `README.md` and other files from `master` to the `gh-pages`\nbranch before generating the pages. To do so, you can add the following job to\nyour workflow before the job that generates the pages:\n\n```yaml\n  update-docs-on-gh-pages-branch:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n        with:\n          # Adjust the depth as needed according to the files you want to copy\n          fetch-depth: 0\n      - name: Copy To Branches Action\n        uses: planetoftheweb/copy-to-branches@v1.1\n        env:\n          # The branch where the files will be copied from\n          key: 'master'\n          # The destination branch\n          branches: 'gh-pages'\n          # The files that will be copied with the relative path, separated by spaces\n          files: 'README.md'\n```\n\n* The page describing this Action was created using itself. So, if you want to\nsee a page generated by this Action, you can access it at\n[https://itamarc.github.io/action-itemplate-ghpages/](https://itamarc.github.io/action-itemplate-ghpages/)\n\n## Credits\n\n(c) 2021 [Itamar Carvalho](https://github.com/itamarc)\n\nThis work uses the following packages and softwares:\n- [`io.github.itamarc:itemplate`](https://github.com/itamarc/itemplate/) version 1.2\n- [`org.json:json`](https://github.com/stleary/JSON-java) version 20210307\n- [`org.apache.httpcomponents:httpclient`](https://hc.apache.org/) version 4.5.13\n- [`com.vladsch.flexmark:flexmark-all`](https://github.com/vsch/flexmark-java/) version 0.62.2\n- [Docker](https://www.docker.com/)\n- [Apache Maven](https://maven.apache.org/)\n- [GitHub GraphQL API](https://docs.github.com/en/graphql)\n- [GitHub Actions](https://docs.github.com/en/actions)\n- [bash](https://www.gnu.org/software/bash/)\n- [git](https://git-scm.com/)\n- [Prism.js](http://prismjs.com/)\n\n## Licence\n\nThis project is under [GNU GPL v3.0](https://choosealicense.com/licenses/gpl-3.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitamarc%2Faction-itemplate-ghpages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitamarc%2Faction-itemplate-ghpages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitamarc%2Faction-itemplate-ghpages/lists"}