forked from thegooddocsproject/templates
-
Notifications
You must be signed in to change notification settings - Fork 0
/
adoc-parameters.txt
29 lines (24 loc) · 905 Bytes
/
adoc-parameters.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
// Global Docs Parameters
:toc: left
:toclevels: 3
:experimental:
:sectnums:
:data-uri:
:source-highlighter: highlightjs
:sectanchors:
:icons: font
:safe-mode-safe:
:version: "latest"
:uri-repo: https://github.com/projectname
:company: REPLACEME
:product: ##Set the product parameter to add the product name here.##
:app: ##Insert the name of the app here.##
:keywords: {app}, {product}, ##Set other global keywords here.##
// 1-developer-guide parameters
:api-version: ##For API Overviews articles. Replace with the current version of the API##
:api-url: ##For API Overviews articles. Example is https://api.{company}.com.au ##
:app-url: ##Set the app-url parameter to replace this value with a URL like https://{app}.{company}.com.au
// 2-qa-and-testing Parameters
:code-lang: ##put the dominant code language used in {app} that you lint against##
// 3-infrastructure Parameters
// 4-how-to-guides