{"id":19891364,"url":"https://github.com/lightbend/antora-ui-lightbend-theme","last_synced_at":"2025-05-02T18:31:18.357Z","repository":{"id":36571826,"uuid":"186876404","full_name":"lightbend/antora-ui-lightbend-theme","owner":"lightbend","description":"Lightbend themed skin for Antora docs","archived":true,"fork":false,"pushed_at":"2023-07-18T21:49:34.000Z","size":5319,"stargazers_count":0,"open_issues_count":30,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-07T04:41:16.215Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Handlebars","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lightbend.png","metadata":{"files":{"readme":"README.adoc","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":"2019-05-15T17:47:03.000Z","updated_at":"2025-03-04T16:49:57.000Z","dependencies_parsed_at":"2023-01-17T02:45:19.212Z","dependency_job_id":null,"html_url":"https://github.com/lightbend/antora-ui-lightbend-theme","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fantora-ui-lightbend-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fantora-ui-lightbend-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fantora-ui-lightbend-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightbend%2Fantora-ui-lightbend-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightbend","download_url":"https://codeload.github.com/lightbend/antora-ui-lightbend-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252088407,"owners_count":21692790,"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":[],"created_at":"2024-11-12T18:18:00.444Z","updated_at":"2025-05-02T18:31:16.491Z","avatar_url":"https://github.com/lightbend.png","language":"Handlebars","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Lightbend Default UI\n// Settings:\n:experimental:\n:hide-uri-scheme:\n// Project URLs:\n:url-project: https://gitlab.com/antora/antora-ui-default\n:url-preview: https://antora.gitlab.io/antora-ui-default\n:url-ci-pipelines: {url-project}/pipelines\n:img-ci-status: {url-project}/badges/master/pipeline.svg\n// External URLs:\n:url-antora: https://antora.org\n:url-git: https://git-scm.com\n:url-git-dl: {url-git}/downloads\n:url-gulp: http://gulpjs.com\n:url-opendevise: https://opendevise.com\n:url-node: https://nodejs.org\n:url-nvm: https://github.com/creationix/nvm\n:url-nvm-install: {url-nvm}#installation\n:url-yarn: https://yarnpkg.com\n\nimage:https://travis-ci.com/lightbend/antora-ui-lightbend-theme.svg?branch=master[\"Build Status\", link=\"https://travis-ci.com/lightbend/antora-ui-lightbend-theme\"]\n\nNOTE\nThis repo is no longer under development, we are currently transitioning to the following Lightbend Antora Theme here: https://github.com/lightbend/antora-supplemental-ui-lightbend-theme\n\n\n\nThis repo contains a zipped Antora UI component that is styled to use with Antora to build documentation for Lightbend's commercial products. You can see a preview of the default UI at {url-preview}.The most common use is to simply refer to this zipped bundle. However, you can also make changes to the UI by modifiying the source files in this repo.  demonstrates how to produce a UI bundle for use in a documentation site generated with {url-antora}[Antora].\n\nTo understand the structure and behavior of the UI, see ./docs/modules/ROOT/pages/index.adoc.\n\nThis readme describes how to:\n\n* xref: use[Use the Lightbend UI in a doc project]\n* xref: preview[Preview and bundle the Lightbend UI]\n\n[[use]]\n== Use the Lightbend UI in a doc project\n\nIf you want to use the default UI for your Antora-generated site, add the following UI configuration to your playbook:\n\n[source,yaml,subs=attributes+]\n----\nui:\n  bundle:\n    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable\n    snapshot: true\n----\n\nRead on to learn how to use your own build of the default UI.\n\n[[preview]]\n== Preview and bundle the Lightbend UI\n\nThis section offers a basic tutorial for learning how to preview the default UI and bundle it for use with Antora.\nA more comprehensive tutorial will be made available in the documentation.\n\n=== Prerequisites\n\nTo preview and bundle the Lightbend UI, you need the following software on your computer:\n\n* {url-git}[git] (command: `git`)\n* {url-node}[Node] (command: `node`)\n* {url-gulp}[Gulp CLI] (command: `gulp`)\n* {url-yarn}[Yarn] (command: `yarn`)\n\n==== git\n\nFirst, make sure you have git installed.\n\n $ git --version\n\nIf not, {url-git-dl}[download and install] the git package for your system.\n\n==== Node\n\nNext, make sure that you have Node.js (herein \"`Node`\") installed.\n\n $ node --version\n\nIf this command fails with an error, you don't have Node installed.\nIf the command doesn't report a Node LTS version (e.g., v10.14.2), you don't have a suitable version of Node installed.\n\nWhile you can install Node from the official packages, we strongly recommend that you use {url-nvm}[nvm] (Node Version Manager) to install and manage Node.\nFollow the {url-nvm-install}[nvm installation instructions] to set up nvm on your machine.\n\nOnce you've installed nvm, open a new terminal and install Node 10 using the following command:\n\n $ nvm install 10\n\nYou can switch to this version of Node at any time using the following command:\n\n $ nvm use 10\n\nTo make Node 10 the default in new terminals, type:\n\n $ nvm alias default 10\n\nNow that you have Node 10 installed, you can proceed with installing the Gulp CLI and Yarn.\n\n==== Gulp CLI\n\nNext, you'll need the Gulp command-line interface (CLI).\nThis package provides the `gulp` command which executes the version of Gulp declared by the project.\n\nYou should install the Gulp CLI globally (which resolves to a location in your user directory if you're using nvm) using the following command:\n\n $ npm install -g gulp-cli\n\n==== Yarn\n\nFinally, you'll need Yarn, which is the preferred package manager for the Node ecosystem.\n\nYou should install Yarn globally (which resolves to a location in your user directory if you're using nvm) using the following command:\n\n $ npm install -g yarn\n\nNow that you have the prerequisites installed, you can fetch and build the default UI project.\n\n=== Clone and Initialize the UI Project\n\nClone the default UI project using git:\n\n[subs=attributes+]\n $ git clone {url-project} \u0026\u0026\n   cd \"`basename $_`\"\n\nThe example above clones Antora's default UI project and then switches to the project folder on your filesystem.\nStay in this project folder in order to initialize the project using Yarn.\n\nUse Yarn to install the project's dependencies.\nIn your terminal, execute the following command (while inside the project folder):\n\n $ yarn install\n\nThis command installs the dependencies listed in [.path]_package.json_ into the [.path]_node_modules/_ folder inside the project.\nThis folder does not get included in the UI bundle.\n\n=== Preview the UI\n\nThe default UI project is configured to preview offline.\nThat's what the files in the [.path]_preview-src/_ folder are for.\nThis folder contains HTML file fragments that provide a representative sample of content from the site.\n\nTo build the UI and preview it in a local web server, run the `preview` command:\n\n $ gulp preview\n\nYou'll see a URL listed in the output of this command:\n\n....\n[12:59:28] Starting 'preview:serve'...\n[12:59:28] Starting server...\n[12:59:28] Server started http://localhost:5252\n[12:59:28] Running server\n....\n\nNavigate to that URL to view the preview site.\n\nWhile this command is running, any changes you make to the source files will be instantly reflected in the browser.\nThis works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.\n\nPress kbd:[Ctrl+C] to stop the preview server and end the continuous build.\n\n=== Package for Use with Antora\n\nIf you need to bundle the UI in order to preview the UI on the real site in local development, run the following command:\n\n $ gulp bundle\n\nThe UI bundle will be available at [.path]_build/ui-bundle.zip_.\nYou can then point Antora at this bundle using the `--ui-bundle-url` command-line option.\n\nIf you have the preview running, and you want to bundle without causing the preview to be clobbered, use:\n\n $ gulp bundle:pack\n\nThe UI bundle will again be available at [.path]_build/ui-bundle.zip_.\n\n== Copyright and License\n\nCopyright (C) 2017-2018 OpenDevise Inc. and the Antora Project.\n\nUse of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).\nSee link:LICENSE[] to find the full license text.\n\n== Authors\n\nDevelopment of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightbend%2Fantora-ui-lightbend-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightbend%2Fantora-ui-lightbend-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightbend%2Fantora-ui-lightbend-theme/lists"}