https://github.com/decidim/documentation-antora-ui

Antora UI adaptation for Decidim Docs
https://github.com/decidim/documentation-antora-ui

Last synced: 12 months ago
JSON representation

Antora UI adaptation for Decidim Docs

• Host: GitHub
• URL: https://github.com/decidim/documentation-antora-ui
• Owner: decidim
• License: mpl-2.0
• Created: 2020-07-29T15:18:35.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-05-09T11:12:48.000Z (about 4 years ago)
• Last Synced: 2025-06-01T09:13:12.871Z (about 1 year ago)
• Language: CSS
• Size: 1.74 MB
• Stars: 0
• Watchers: 18
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
:url-antora: https://antora.org

:url-antora-docs: https://docs.antora.org

:url-antora-ui-repository: https://gitlab.com/antora/antora-ui-default

:url-project: https://github.com/decidim/documentation-antora-ui

:url-git: https://git-scm.com

:url-gulp: http://gulpjs.com

:url-opendevise: https://opendevise.com

:url-nodejs: https://nodejs.org

= Antora Decidim UI

This 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]

== Use this UI

If you want to use this UI, you can do so by:

[source,yaml]

----

ui:

  bundle:

    url: https://github.com/decidim/docs.decidim.org-ui/-/TODO/master/raw/build/ui-bundle.zip?job=bundle-stable

    snapshot: true

----

== Development Quickstart

This 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.

A more comprehensive can be found in the documentation at {url-antora-docs}.

=== Prerequisites

To preview and bundle this UI, you need the following software on your computer:

* {url-git}[git] (command: `git`)

* {url-nodejs}[Node.js] (commands: `node` and `npm`)

* {url-gulp}[Gulp CLI] (command: `gulp`)

==== Gulp CLI

You'll need the Gulp command-line interface (CLI) to run the build.

The Gulp CLI package provides the `gulp` command which, in turn, executes the version of Gulp declared by the project.

 $ npm install -g gulp-cli

Verify the Gulp CLI is installed and on your PATH by running:

 $ gulp --version

[subs=attributes+]

 $ git clone {url-project} &&

   cd "`basename $_`"

Install dependencies with:

 $ npm install

=== Preview the UI

The default UI project is configured to preview offline.

The files in the [.path]_preview-src/_ folder provide the sample content that allow you to see the UI in action.

In this folder, you'll primarily find pages written in AsciiDoc.

These pages provide a representative sample and kitchen sink of content from the real site.

To build the UI and preview it in a local web server, run the `preview` command:

 $ gulp preview

You'll see a URL listed in the output of this command:

....

[12:00:00] Starting server...

[12:00:00] Server started http://localhost:5252

[12:00:00] Running server

....

Navigate to this URL to preview the site locally.

While this command is running, any changes you make to the source files will be instantly reflected in the browser.

This works by monitoring the project for changes, running the `preview:build` task if a change is detected, and sending the updates to the browser.

Press kbd:[Ctrl+C] to stop the preview server and end the continuous build.

=== Package for Use with Antora

If you need to package the UI so you can use it to generate the documentation site locally, run the following command:

 $ gulp bundle

If any errors are reported by lint, you'll need to fix them.

When the command completes successfully, the UI bundle will be available at [.path]_build/ui-bundle.zip_.

You can point Antora at this bundle using the `--ui-bundle-url` command-line option.

If you have the preview running, and you want to bundle without causing the preview to be clobbered, use:

 $ gulp bundle:pack

The UI bundle will again be available at [.path]_build/ui-bundle.zip_.

== Copyright and License

Copyright (C) 2017-2019 OpenDevise Inc. and the Antora Project.

Use 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).

See link:LICENSE[] to find the full license text.

== Authors

Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].