Skip to content

Latest commit

 

History

History
113 lines (72 loc) · 4.2 KB

README.md

File metadata and controls

113 lines (72 loc) · 4.2 KB
Raw

Spring

On Push

This project generates and packages the static resources that Spring uses for document production.

This project is based on Antora.

Development Quickstart

This section offers a basic tutorial to teach you how to preview it locally, and bundle it for use with Antora. A more comprehensive tutorial can be found in the documentation at docs.antora.org.

Prerequisites

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

Preview the UI

The Spring Antora UI project is configured to preview offline. The files in the 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:

npm install
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 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 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 build/ui-bundle.zip.

Extensions to the UI

Related Documentation

The UI presents a list of related documentation and that documentation can be filtered using two attributes:

  • page-related-doc-categories - The categories to be included in the related documentation
  • page-related-doc-projects - The project ids to be included in the related documentation

For a complete listing of valid categories and ids view related_projects.js

The configuration is typically specified in asciidoc attributes section of the antora-playbook.yml:

asciidoc:
  attributes:
    # Include the projects with the security category
    page-related-doc-categories: security
    # Include the projects with ids framework and graphql
    page-related-doc-projects: framework,graphql

The Related Documentation links to the All Docs... page. To include this resource, ensure that the antora-extensions is using 1.7.0+ and the Static Page Extension is included.

Authors

Development of Antora is led and sponsored by OpenDevise Inc.

Copyright and License

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

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0). See LICENSE to find the full license text.