{"id":16553488,"url":"https://github.com/infotexture/dita-bootstrap","last_synced_at":"2025-09-12T13:40:59.383Z","repository":{"id":38361092,"uuid":"106340462","full_name":"infotexture/dita-bootstrap","owner":"infotexture","description":"DITA Open Toolkit plug-in for HTML5 with extensible Bootstrap style","archived":false,"fork":false,"pushed_at":"2025-09-07T20:48:27.000Z","size":15024,"stargazers_count":16,"open_issues_count":2,"forks_count":11,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-09-07T22:24:46.631Z","etag":null,"topics":["bootstrap","dita","dita-ot","dita-ot-html-plugin","dita-ot-plugin","html","html5","publishing"],"latest_commit_sha":null,"homepage":"https://infotexture.github.io/dita-bootstrap","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/infotexture.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-10-09T22:10:15.000Z","updated_at":"2025-09-07T20:46:11.000Z","dependencies_parsed_at":"2024-02-07T20:30:37.734Z","dependency_job_id":"7377fb54-436c-41f8-8811-3e7df053bb39","html_url":"https://github.com/infotexture/dita-bootstrap","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/infotexture/dita-bootstrap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infotexture%2Fdita-bootstrap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infotexture%2Fdita-bootstrap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infotexture%2Fdita-bootstrap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infotexture%2Fdita-bootstrap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infotexture","download_url":"https://codeload.github.com/infotexture/dita-bootstrap/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infotexture%2Fdita-bootstrap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274822811,"owners_count":25356594,"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-09-12T02:00:09.324Z","response_time":60,"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":["bootstrap","dita","dita-ot","dita-ot-html-plugin","dita-ot-plugin","html","html5","publishing"],"created_at":"2024-10-11T19:48:25.464Z","updated_at":"2025-09-12T13:40:59.352Z","avatar_url":"https://github.com/infotexture.png","language":"XSLT","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DITA Bootstrap\n\nA plug-in for [DITA Open Toolkit][1] that extends the default HTML5 output with a basic [Bootstrap][2] template.\n\n\u003c!-- MarkdownTOC levels=\"2,3\" --\u003e\n\n- [Installing](#installing)\n- [Using](#using)\n- [Customizing](#customizing)\n  - [Bootswatch themes](#bootswatch-themes)\n  - [Custom CSS](#custom-css)\n  - [Headers and footers](#headers-and-footers)\n  - [Navigation menu](#navigation-menu)\n  - [Common Bootstrap utility classes](#common-bootstrap-utility-classes)\n  - [Bootstrap icons for DITA notes](#bootstrap-icons-for-dita-notes)\n  - [Optional elements](#optional-elements)\n- [Feedback](#feedback)\n- [License](#license)\n\n\u003c!-- /MarkdownTOC --\u003e\n\n![Sample DITA Bootstrap output](images/default-bootstrap.png)\n\n## Installing\n\nUse the `dita` command to add this plug-in to your DITA Open Toolkit installation:\n\nDITA-OT 3.5 and newer:\n\n```console\ndita install fox.jason.extend.css\ndita install net.infotexture.dita-bootstrap\n```\n\nDITA-OT 3.3 and newer:\n\n```console\ndita --install fox.jason.extend.css\ndita --install net.infotexture.dita-bootstrap\n```\n\nDITA-OT 3.2 and older:\n\n```console\ndita --install \\\n       https://github.com/jason-fox/fox.jason.extend.css/archive/master.zip\ndita --install \\\n       https://github.com/infotexture/dita-bootstrap/archive/master.zip\n```\n\n## Using\n\nSpecify the `html5-bootstrap` format when building output with the `dita` command:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap\n```\n\n## Customizing\n\n### Bootswatch themes\n\nAlternate Bootstrap themes can be downloaded directly from [Bootswatch][3].\n\nTo override the default appearance with a Bootswatch theme, pass a theme name to the `dita` command via the `--bootstrap.theme` parameter:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap \\\n     --args.hdr=path/to/your-header.xml \\\n     --bootstrap.theme=\u003ctheme-name\u003e\n```\n\n### Custom CSS\n\nTo extend the chosen theme, pass a custom CSS file to the `dita` command via the `--args.css` parameter.\n\nFor a complete override of the theme where the default Bootstrap CSS is no longer required, you can disable it by setting `--bootstrap.theme=none`:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap \\\n     --args.hdr=path/to/your-header.xml \\\n     --bootstrap.theme=none \\\n     --args.css=\u003cname-of-css\u003e.css \\\n     --args.copycss=yes \\\n     --args.csspath=css \\\n     --args.cssroot=path/to/your/theme\n```\n\n\u003e **Note**\n\u003e For more extensive customizations with [Sass][4], you may want to install the [dita-bootstrap.sass][5] plug-in.\n\n### Headers and footers\n\nThe plug-in includes a default static navigation menu with a project name and global link placeholders.\n\nThe default header file `includes/hdr.navbar.default.xml` uses the Bootstrap primary (blue) background color for the [navbar component][6]. Bootstrap itself offers additional [header examples][7].\n\nTo change the color to a dark (black) background, replace the primary background color class `bg-primary` on the first line with the dark variant `bg-dark`:\n\n```diff\n- \u003cnav class=\"navbar navbar-expand-lg navbar-dark bg-primary\"\u003e\n+ \u003cnav class=\"navbar navbar-expand-lg navbar-dark bg-dark\"\u003e\n```\n\nYou can edit a copy of this file to adjust the content of the global navigation. To override the global navigation with your own header, pass a custom header file to the `dita` command via the `--args.hdr` parameter:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap \\\n     --args.hdr=path/to/your-header.xml\n```\n\nThe plug-in includes a sample [header alternative with a light navbar][8].\n\nNo footer is added by default, but the plug-in also includes a sample [footer file][9] and Bootstrap also offers additional [examples][10]. To add a footer to the generated output, pass a custom footer file to the `dita` command via the `--args.ftr` parameter:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap \\\n     --args.ftr=path/to/your-footer.xml\n```\n\n### Navigation menu\n\nThe plug-in extends the standard HTML5 table of contents (ToC) [navigation parameter][11] `--nav-toc` to add styled list groups to the navigation menu. (The navigation is rendered as a sidebar in desktop browsers and above the content on smaller devices.)\n\nBy default, the plug-in uses the `partial` option to include the current topic in the ToC along with its parents, siblings and children. As with the default HTML5 plug-in, the `full` option can also be used to generate a complete ToC for the entire map, or `none` to disable the table of contents entirely.\n\nAs of version 5.3.1, the plug-in provides five new options to style the table of contents navigation with either the Bootstrap [list group][12] component, [nav-pills][13], or [collapsible][14] menus:\n\n- `list-group-full` – Styled full ToC within a Bootstrap list group\n- `list-group-partial` – Partial ToC with the current topic, parents, siblings, and children in a list group\n- `nav-pill-full` – Styled full ToC using Bootstrap nav-pills\n- `nav-pill-partial` – Partial ToC with the current topic, parents, siblings, and children using Bootstrap nav-pills\n- `collapsible` – Styled full ToC with collapsible list elements\n\nTo use these options, pass the desired value to the `dita` command via the `--nav-toc` parameter:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap \\\n     --nav-toc=list-group-partial\n```\n\nFor an example of `collapsible` styling, see the output at [infotexture.github.io/dita-bootstrap][15].\n\nAdditionally, the first-level navigation menu can be switched to a horizontal Bootstrap menu bar to reduce the depth of the ToC.\n\nTo use this option, add the `--menubar-toc.include=yes` parameter to the `dita` command:\n\n```console\ndita --input=path/to/your.ditamap \\\n     --format=html5-bootstrap \\\n     --nav-toc=list-group-partial  \\\n     --menubar-toc.include=yes\n```\n\n### Common Bootstrap utility classes\n\nThe HTML output for the following DITA elements can be annotated with common Bootstrap utility classes for borders, background, text, spacing, etc. using additional command line parameters:\n\n- `bootstrap.css.accessibility.link` – Common Bootstrap utility classes for accessibility links\n- `bootstrap.css.accessibility.nav` – Common Bootstrap utility classes for accessibility navigation\n- `bootstrap.css.accordion` – Common utility classes for Bootstrap accordion components\n- `bootstrap.css.card` – Common utility classes for Bootstrap card components\n- `bootstrap.css.carousel` – Common utility classes for Bootstrap carousel components\n- `bootstrap.css.carousel.caption` – Common utility classes for Bootstrap carousel captions\n- `bootstrap.css.carousel.indicators` – Common utility classes for Bootstrap carousel indicators\n- `bootstrap.css.codeblock` – Common Bootstrap utility classes for DITA `\u003ccodeblock\u003e` elements\n- `bootstrap.css.container.size` – Bootstrap container class for main layout and menubar-TOC. Options: `container`, `container-fluid`, `container-sm`, `container-md`, `container-lg`, `container-xl`, `container-xxl` (default)\n- `bootstrap.css.dd` – Common utility classes for DITA `\u003cdd\u003e` elements\n- `bootstrap.css.dl` – Common utility classes for DITA `\u003cdl\u003e` elements\n- `bootstrap.css.dt` – Common utility classes for DITA `\u003cdt\u003e` elements\n- `bootstrap.css.figure` – Common utility classes for DITA `\u003cfig\u003e` elements\n- `bootstrap.css.figure.caption` – Common utility classes for DITA figure titles\n- `bootstrap.css.figure.image` – Common utility classes for images within DITA`\u003cfig\u003e` elements\n- `bootstrap.css.footer` – Common utility classes for the HTML `\u003cfooter\u003e` element\n- `bootstrap.css.nav.parent` – Common utility classes for ancestors of active nav-pill elements\n- `bootstrap.css.pagination` – Common utility classes for Bootstrap pagination components\n- `bootstrap.css.section.title` – Common Bootstrap utility classes for DITA `\u003csection\u003e` titles\n- `bootstrap.css.shortdesc` – Common Bootstrap utility classes for DITA`\u003cshortdesc\u003e` elements\n- `bootstrap.css.table` – Common utility classes for DITA `\u003ctable\u003e` elements\n- `bootstrap.css.tabs` – Common utility classes for Bootstrap horizontal tab components\n- `bootstrap.css.tabs.vertical` – Common utility classes for Bootstrap vertical tabs\n- `bootstrap.css.thead` – Common utility classes for DITA `\u003cthead\u003e` elements\n- `bootstrap.css.topic.title` – Common Bootstrap utility classes for DITA `\u003ctopic\u003e` titles\n\nYou can add your own XSLT customizations by creating a new plug-in that extends the DITA Bootstrap XSLT transforms. Just amend `args.xsl` to point to your own XSLT files. An [XSLT template][16] is included within this repository.\n\n### Bootstrap icons for DITA notes\n\nThe default Bootstrap icons used for DITA `\u003cnote\u003e` elements can be overridden using additional command line parameters:\n\n- `bootstrap.icon.note` – Icon for standard notes\n- `bootstrap.icon.attention` – Icon for attention notes\n- `bootstrap.icon.caution` – Icon for caution notes\n- `bootstrap.icon.danger` – Icon for danger notes\n- `bootstrap.icon.fastpath` – Icon for fastpath notes\n- `bootstrap.icon.important` – Icon for important notes\n- `bootstrap.icon.notice` – Icon for notice notes\n- `bootstrap.icon.remember` – Icon for remember notes\n- `bootstrap.icon.restriction` – Icon for restriction notes\n- `bootstrap.icon.tip` – Icon for tips\n- `bootstrap.icon.trouble` – Icon for trouble notes\n- `bootstrap.icon.warning` – Icon for warning notes\n\n### Optional elements\n\nBootstrap icons, popovers, tooltips and the dark-mode toggler are enabled by default, but for performance reasons they can be disabled by setting the following command line parameters to `no`:\n\n- `icons.include` – Enable Bootstrap icons\n- `popovers.include` – Enable Bootstrap popover components and tooltip components\n- `dark.mode.include` – Whether to include support for a [dark mode][14] toggler\n\nAdditionally, opt-in breadcrumbs and menu bars and other modifiers can be added using the following parameters\n\n- `args.breadcrumbs` – Add Bootstrap breadcrumb components\n- `menubar-toc.include` – Add a Bootstrap menubar\n- `scrollspy-toc` – Add a Bootstrap [scrollspy][17] navigator\n- `bidi.include` – Whether to force included support for RTL languages\n- `toc-spacer.padding` – Vertical padding to add to the side menu\n\n## Feedback\n\n- If you find this useful and build something of your own on top of it, [let me know][18].\n\n- If you find a bug or would like to suggest a change, [create an issue][19].\n  _(If it’s a bug, provide steps to recreate the issue.)_\n\n- If you know how to fix it yourself, [submit a pull request][20] with the proposed changes.\n\n## License\n\n[Apache 2.0](LICENSE) © 2017–2025 Roger W. Fienhold Sheen\n\nThe generated HTML created by this software includes the following additional software components which are obtained under license:\n\n- Bootstrap – https://github.com/twbs/bootstrap – **MIT license**\n- Bootstrap Icons – https://github.com/twbs/icons – **MIT license**\n- Bootswatch Themes – https://github.com/thomaspark/bootswatch – **MIT license**\n\nWithin the sample documentation, where necessary, the texts describing the usage of each component have been copied directly from the official [Bootstrap 5.3 documentation][2], however DITA markup is used throughout the examples describing how to implement these components correctly using `outputclass`. The text is therefore a derivative of \"Bootstrap 5.3 docs\" by Twitter, Inc. and the Bootstrap Authors, and used under CC BY 3.0.\n\n[1]: http://www.dita-ot.org\n[2]: https://getbootstrap.com/docs/5.3\n[3]: https://bootswatch.com\n[4]: https://sass-lang.com\n[5]: https://github.com/infotexture/dita-bootstrap.sass\n[6]: https://getbootstrap.com/docs/5.3/examples/navbars/\n[7]: https://getbootstrap.com/docs/5.3/examples/headers/\n[8]: ./includes/hdr.navbar.example.xml\n[9]: ./includes/ftr.content.example.xml\n[10]: https://getbootstrap.com/docs/5.3/examples/footers/\n[11]: https://www.dita-ot.org/dev/parameters/parameters-html5.html#html5__nav-toc\n[12]: https://getbootstrap.com/docs/5.3/components/list-group/\n[13]: https://getbootstrap.com/docs/5.3/components/collapse/\n[14]: https://getbootstrap.com/docs/5.3/customize/color-modes/#dark-mode\n[15]: https://infotexture.github.io/dita-bootstrap\n[16]: ./xsl/html5-bootstrap-template.xsl\n[17]: https://getbootstrap.com/docs/5.3/components/scrollspy/\n[18]: https://indieweb.social/@infotexture\n[19]: https://github.com/infotexture/dita-bootstrap/issues/new\n[20]: https://help.github.com/articles/using-pull-requests/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfotexture%2Fdita-bootstrap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfotexture%2Fdita-bootstrap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfotexture%2Fdita-bootstrap/lists"}