{"id":15600612,"url":"https://github.com/jason-fox/fox.jason.favicon","last_synced_at":"2026-02-08T18:04:01.948Z","repository":{"id":119826015,"uuid":"453981880","full_name":"jason-fox/fox.jason.favicon","owner":"jason-fox","description":" A DITA-OT Plug-in used to add a favicon to DITA HTML output.","archived":false,"fork":false,"pushed_at":"2024-02-18T08:49:52.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T12:26:53.779Z","etag":null,"topics":["dita-ot-html-plugin","dita-ot-plugin","favicon"],"latest_commit_sha":null,"homepage":"https://jason-fox.github.io/dita-ot-plugins/favicon/index.html","language":"XSLT","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jason-fox.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-31T11:36:12.000Z","updated_at":"2022-01-31T19:50:00.000Z","dependencies_parsed_at":"2024-02-18T09:31:59.591Z","dependency_job_id":"dbf6afb1-a0b6-41b6-bfcf-9bf4e18a97e4","html_url":"https://github.com/jason-fox/fox.jason.favicon","commit_stats":{"total_commits":10,"total_committers":1,"mean_commits":10.0,"dds":0.0,"last_synced_commit":"48c3218f25238471f704d8050156b6e63aed1947"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/jason-fox/fox.jason.favicon","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.favicon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.favicon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.favicon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.favicon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jason-fox","download_url":"https://codeload.github.com/jason-fox/fox.jason.favicon/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jason-fox%2Ffox.jason.favicon/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267685296,"owners_count":24127706,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["dita-ot-html-plugin","dita-ot-plugin","favicon"],"created_at":"2024-10-03T02:04:55.608Z","updated_at":"2026-02-08T18:04:01.890Z","avatar_url":"https://github.com/jason-fox.png","language":"XSLT","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HTML Favicon Plugin for DITA-OT\n\n[![license](https://img.shields.io/github/license/jason-fox/fox.jason.favicon.svg)](http://www.apache.org/licenses/LICENSE-2.0)\n[![DITA-OT 4.2](https://img.shields.io/badge/DITA--OT-4.2-green.svg)](http://www.dita-ot.org/4.2)\n\nThis is a [DITA-OT Plug-in](https://www.dita-ot.org/plugins) used to add a favicon to DITA HTML output.\n\nA favicon is a file containing a small brand image icon, associated with a particular website or web page.  A web designer\ncan create such an icon and  upload it to a website, and graphical web browsers can then make use of it by displaying the icon \non the associated browser tab.\n\n![](https://jason-fox.github.io/fox.jason.favicon/favicon.png)\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e\u003c/summary\u003e\n\n-   [Background](#background)\n-   [Install](#install)\n    -   [Installing DITA-OT](#installing-dita-ot)\n    -   [Installing the Plug-in](#installing-the-plug-in)\n-   [Usage](#usage)\n-   [License](#license)\n\n\u003c/details\u003e\n\n## Install\n\nThe DITA-OT Favicon Plug-in  has been tested against [DITA-OT 4.x](http://www.dita-ot.org/download). It is recommended\nthat you upgrade to the latest version.\n\n### Installing DITA-OT\n\n\u003ca href=\"https://www.dita-ot.org\"\u003e\u003cimg src=\"https://www.dita-ot.org/images/dita-ot-logo.svg\" align=\"right\" height=\"55\"\u003e\u003c/a\u003e\n\nThe DITA-OT Favicon Plug-in  is a file reader for the DITA Open Toolkit.\n\n-   Full installation instructions for downloading DITA-OT can be found\n    [here](https://www.dita-ot.org/4.2/topics/installing-client.html).\n\n    1.  Download the `dita-ot-4.2.zip` package from the project website at\n        [dita-ot.org/download](https://www.dita-ot.org/download)\n    2.  Extract the contents of the package to the directory where you want to install DITA-OT.\n    3.  **Optional**: Add the absolute path for the `bin` directory to the _PATH_ system variable.\n\n    This defines the necessary environment variable to run the `dita` command from the command line.\n\n```console\ncurl -LO https://github.com/dita-ot/dita-ot/releases/download/4.2/dita-ot-4.2.zip\nunzip -q dita-ot-4.2.zip\nrm dita-ot-4.2.zip\n```\n\n### Installing the Plug-in\n\n-   Run the plug-in installation commands:\n\n```console\ndita install https://github.com/jason-fox/fox.jason.favicon/archive/master.zip\n```\n\nThe `dita` command line tool requires no additional configuration.\n\n---\n\n\n## Usage\n\n\n#### Creating HTML output\n\nTo run, use any `html` transform and add the `args.favicon`, `args.faviconpath` and `args.faviconroot` parameters.\nThe new `args.favicon.*` parameters follow the existing syntax used by DITA-OT for CSS files.\n\n```console\nPATH_TO_DITA_OT/bin/dita -f [html5|xhtml]  -o out -i PATH_TO_DITAMAP \\\n  --args.favicon=FILENAME \\\n  --args.faviconpath=DESTINATION_PATH_OF_FAVICON  \\\n  --args.faviconroot=SOURCE_PATH_OF_FAVICON \\\n```\n\nTo refer to an exisiting file hosted on a server, use a URL as the `args.faviconpath` parameter\n\n```console\nPATH_TO_DITA_OT/bin/dita -f [html5|xhtml]  -o out -i PATH_TO_DITAMAP \\\n  --args.favicon=FILENAME \\\n  --args.faviconpath=https://example.com/static/assets\n```\n\n### Parameter Reference\n\n-  `args.favicon` - Specifies the name of the favicon file. The value of this parameter should be only the file name. The absolute path\n    to the parent directory should be specified with `args.faviconroot`. Defaults to [`favicon.svg`](/includes/favicon.svg) - the name of\n    the default image found within the plugin itself\n\n-  `args.faviconpath` - Specifies the destination directory to which the favicon file is copied (relative to the output directory). Corresponds\n    to the XSLT parameter `FAVICONPATH`. DITA-OT will copy the file to this location.\n\n\u003e Tip: If `args.faviconpath` is not set, the favicon file will be copied to the root level of the \n\u003e output folder. To move the favicon file to an output subfolder named `/static/assets`, set \n\u003e `args.faviconpath` to `/static/assets`.\n\n-  `args.faviconroot` - specifies the source directory that contains the favicon file.\n    DITA-OT will copy the file from this location. Defaults to the image found within the plugin itself\n\n\u003e Important: Enter the absolute path to the parent directory of the favicon file specified with \n\u003e `args.favicon`.\n\n## License\n\n[Apache 2.0](LICENSE) © 2022 - 2024 Jason Fox\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjason-fox%2Ffox.jason.favicon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjason-fox%2Ffox.jason.favicon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjason-fox%2Ffox.jason.favicon/lists"}