Git Product home page Git Product logo

rp-antora's Introduction

rp-antora

Referencing information architecture: Landing Page - Enterprise Prime Documentation

Testing Rancher docs on Antora

Testing locally

To test antora setup and changes made on your machine.

  1. Fork repo: https://github.com/LucasSaintarbor/rp-antora
  2. In antora-playbook.yml, change source URL to:
    content:
        sources:
        - url: ./
    
  3. Run npx antora antora-playbook.yml to build and preview Antora site.

Testing by referencing repo

To test antora setup on https://github.com/LucasSaintarbor/rp-antora.

  1. Clone repo: https://github.com/LucasSaintarbor/rp-antora

  2. Run npx antora --fetch antora-playbook.yml Run npx antora antora-playbook.yml to build and preview Antora site.

Notes about Antora

Overview

  • Antora uses AsciiDoctor to convert AsciiDoc to HTML.
  • Antora has multiple idependent components.
  • Each component is identified by name and verison.
  • Eanch component can have multiple modules.
  • Each module has pre-defined families for pages, images, examples, attahcments, and partials (content to included in multiple places).
  • Advanced feature: A component can be distributed across multiple folders, branches, and repositories.

What Anotora Does

  1. Load Antora playbook with list of repositories and branches.
  2. Clone Git repositories.
  3. Create HTML output from AsciiDoc.
  4. Merge with UI theme and UI customizations.
  5. Creates a search index.
  6. Creates an output folder with a static site.

rp-antora's People

Contributors

lucassaintarbor avatar

Stargazers

Marty Hernandez Avedon avatar

Watchers

 avatar

Forkers

martyav

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.