From 862c487bd1579e0ccb3fcd39e3c48b8e2e56c6c1 Mon Sep 17 00:00:00 2001 From: Brian Dominick Date: Wed, 10 Apr 2019 20:39:43 -0400 Subject: [PATCH] Add links to GH and resources to new docs Overview --- README.adoc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.adoc b/README.adoc index fd94060..fde1f95 100644 --- a/README.adoc +++ b/README.adoc @@ -37,6 +37,12 @@ LiquiDoc is a documentation build utility for true single-sourcing of technical It is especially suited for documentation projects with various required output formats from complex, single-sourced codebases, but it is intended for any project with complex, versioned input data for use in docs, user interfaces, and even back-end code. The highly configurable command-line utility (and Ruby gem) engages template engines to parse complex data into rich text output, from *blogs* to *books* to *knowledge bases* to *slide presentations*. +ifndef::env-github[] +[NOTE] +LiquiDoc's prime source is on link:https://github.com/DocOps/liquidoc-cmf[icon:github[] Github]. + +Use the Issues feature for support requests, or find us on link:https://gitter.im/liquidoc-cmf/Lobby[LiquiDoc icon:gitter[] Gitter] or link:https://www.writethedocs.org/slack/[Write the Docs AsciiDoc channel] on icon:slack[] Slack. +endif::[] + Content source is formatted in the incredible *AsciiDoc lightweight markup* language. Data sources can be flat files in formats such as *XML* (eXtensible Markup Language), *JSON* (JavaScript Object Notation), *CSV* (comma-separated values), and our preferred human-editable format: *YAML* (acronym link:https://en.wikipedia.org/wiki/YAML#History_and_name[in dispute]). LiquiDoc also accepts *regular expressions* to parse unconventionally formatted files. @@ -156,6 +162,8 @@ bundle exec asciidoctor -r pdf docs/index.adoc -o docs/liquidoc-manual.pdf open docs/liquidoc-manual.pdf ---- +. Open the new file in your preferred browser or PDF reader + == Usage The instructions that formerly stood here have been used to the official LiquiDoc Admin and User Manual.