ACMEdoc Developer Guide | ACMEdoc Docs-as-Code Platform

Welcome to the ACMEdoc Developer Guide!

Here you will learn to extend and customize ACMEdoc as a developer.

The content above appears in all editions, but some of it is variable. Many of the strings (e.g., ACMEdoc and even extend and customize, etc) are variables ({portal_product} and {user_verb}) are dynamically substituted with AsciiDoc attributes at build time. The content is included from a common file, like so:

 include::includes/intro_portal_common.adoc[]

As a developer, you will have access to a sandboxed version of the product for configured for development and testing. Your Guide includes documentation of all Basic and Premium features as well as information required to extend the product.

The above text is from a dynamically included file using:

 include::portal/intro_portal_{portal_slug}.adoc[]

Where {portal_slug} is a variable defined in a block of a YAML file (_configs/portals.yml) that is only passed to one designated portal during the build config file (_configs/build-docs.yml), where it is designated as data: _data/portals.yml:portal-3.

This document contains lots of jargon. See the Jargon Guide if you get lost.