{"id":28433025,"url":"https://github.com/decidim/documentation-antora-ui","last_synced_at":"2025-07-01T11:30:58.551Z","repository":{"id":83335384,"uuid":"283533350","full_name":"decidim/documentation-antora-ui","owner":"decidim","description":"Antora UI adaptation for Decidim Docs","archived":false,"fork":false,"pushed_at":"2022-05-09T11:12:48.000Z","size":1827,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-06-01T09:13:12.871Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"CSS","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/decidim.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,"governance":null}},"created_at":"2020-07-29T15:18:35.000Z","updated_at":"2022-05-09T11:11:22.000Z","dependencies_parsed_at":"2023-09-25T06:59:33.362Z","dependency_job_id":null,"html_url":"https://github.com/decidim/documentation-antora-ui","commit_stats":{"total_commits":623,"total_committers":29,"mean_commits":"21.482758620689655","dds":0.1107544141252006,"last_synced_commit":"1cdd5ccb001ac0ce3c2733d016316145542dd6cb"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decidim%2Fdocumentation-antora-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decidim%2Fdocumentation-antora-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decidim%2Fdocumentation-antora-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decidim%2Fdocumentation-antora-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decidim","download_url":"https://codeload.github.com/decidim/documentation-antora-ui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decidim%2Fdocumentation-antora-ui/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":257626693,"owners_count":22575066,"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":"2025-06-05T17:36:43.200Z","updated_at":"2025-07-01T11:30:58.542Z","avatar_url":"https://github.com/decidim.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":":url-antora: https://antora.org\n:url-antora-docs: https://docs.antora.org\n:url-antora-ui-repository: https://gitlab.com/antora/antora-ui-default\n:url-project: https://github.com/decidim/documentation-antora-ui\n:url-git: https://git-scm.com\n:url-gulp: http://gulpjs.com\n:url-opendevise: https://opendevise.com\n:url-nodejs: https://nodejs.org\n\n= Antora Decidim UI\n\nThis project is Decidim adaptation for {url-antora}[Antora], used by the Decidim Documentation website. This is based on the {url-antora-ui-repository}[antora-default-ui]\n\n== Use this UI\n\nIf you want to use this UI, you can do so by:\n\n[source,yaml]\n----\nui:\n  bundle:\n    url: https://github.com/decidim/docs.decidim.org-ui/-/TODO/master/raw/build/ui-bundle.zip?job=bundle-stable\n    snapshot: true\n----\n\n== Development Quickstart\n\nThis section offers a basic tutorial to teach you how to set up the default UI project, preview it locally, and bundle it for use with Antora.\nA more comprehensive can be found in the documentation at {url-antora-docs}.\n\n=== Prerequisites\n\nTo preview and bundle this UI, you need the following software on your computer:\n\n* {url-git}[git] (command: `git`)\n* {url-nodejs}[Node.js] (commands: `node` and `npm`)\n* {url-gulp}[Gulp CLI] (command: `gulp`)\n\n==== Gulp CLI\n\nYou'll need the Gulp command-line interface (CLI) to run the build.\nThe Gulp CLI package provides the `gulp` command which, in turn, executes the version of Gulp declared by the project.\n\n $ npm install -g gulp-cli\n\nVerify the Gulp CLI is installed and on your PATH by running:\n\n $ gulp --version\n\n[subs=attributes+]\n $ git clone {url-project} \u0026\u0026\n   cd \"`basename $_`\"\n\nInstall dependencies with:\n\n $ npm install\n\n=== Preview the UI\n\nThe default UI project is configured to preview offline.\nThe files in the [.path]_preview-src/_ folder provide the sample content that allow you to see the UI in action.\nIn this folder, you'll primarily find pages written in AsciiDoc.\nThese pages provide a representative sample and kitchen sink of content from the real 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:00:00] Starting server...\n[12:00:00] Server started http://localhost:5252\n[12:00:00] Running server\n....\n\nNavigate to this URL to preview the site locally.\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 package the UI so you can use it to generate the documentation site locally, run the following command:\n\n $ gulp bundle\n\nIf any errors are reported by lint, you'll need to fix them.\n\nWhen the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.\nYou can 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-2019 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%2Fdecidim%2Fdocumentation-antora-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecidim%2Fdocumentation-antora-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecidim%2Fdocumentation-antora-ui/lists"}