Skip to content

Pantheon CMD is an open source and freely distributed program for validating and building local previews of modular documentation.

License

Notifications You must be signed in to change notification settings

redhataccess/pantheon-cmd

Repository files navigation

Pantheon CMD

Pantheon CMD is a Python-based command-line tool that allows you to generate a rendered preview of modular documentation using the new HAML templates.

Directory Structure

The top level of this repository contains the following files and directories:

build A directory that contains the latest RPM for the script, and the SPEC file used to generate the RPM.

make.sh A script used to package the script as an RPM-based package that can be installed using yum or dnf.

PantheonCMD A directory containing the source files for the script, and the man page file.

Updating the Script

All additions and updates to the script are welcome.

Packaging the Script

After you update the manifest updater and test the changes, you can build an RPM-based package for the script so that it can be installed on systems that use yum or dnf.

  1. Install the svn and rpmbuild packages on your system:
    # on RHEL
    $ sudo yum install subversion
    $ sudo yum install rpm-build
    
    # on Fedora
    $ sudo dnf install subversion
    $ sudo dnf install rpm-build
  2. Open ./build/pantheon-cmd.spec.
  3. Increment the value of the Release number.
  4. Run the build script:
    $ sh make.sh 1.0

Installing Pantheon CMD

Install Pantheon CMD on a local system.

Installing Pantheon CMD on RHEL and Fedora

Install the RPM and all Ruby gem dependencies.

  1. Install the RPM:

    $ sudo dnf localinstall build/pantheon-cmd-1.0-X.el8.noarch.rpm

    Note that your rpm filename might be different, for example, if you are running Fedora.

  2. Install Ruby gem dependencies:

    $ sudo gem install asciidoctor concurrent-ruby haml tilt

The script is installed on your local machine. The script provides the pcmd command. Enter pcmd -h in your terminal to view the basic usage instructions.

Installing Pantheon CMD on OSX

Install the dependencies and copy the source files into your local binaries directory.

  1. Clone the repository:

    $ git clone
    
  2. Run the osx-cmd-intallation.sh installation script:

    $ /bin/bash osx-cmd-intallation.sh
    

Licenscing

This script uses locale attributes files from the AsciiDoctor repository.

For more information, see https://github.com/asciidoctor/asciidoctor/tree/master/data/locale

About

Pantheon CMD is an open source and freely distributed program for validating and building local previews of modular documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published