Skip to content

Commit 80929b6

Browse files
authored
Merge pull request #1 from jensschuppe/dev_mkdocs
Provide MKDocs documentation.
2 parents 1f61d2d + bf60426 commit 80929b6

File tree

3 files changed

+26
-4
lines changed

3 files changed

+26
-4
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# CiviCRM Contact Inactive Extension
22

3-
Adds a contact action "Set to Inactive" which enables all privacy options and cancels activities of type "Phone Call"
3+
Adds a contact action "Set to Inactive" which enables all privacy options and
4+
cancels activities of type "Phone Call"
45

56
## Customising
6-
The list of activity types that should be cancelled are specified using the setting:
7-
```ContactInactive Preferences:activityTypeNames```
7+
The list of activity types that should be cancelled are specified using the
8+
setting: `ContactInactive Preferences:activityTypeNames`
89

910
Default value is "Phone Call".
1011

1112
## Usage
12-
Either via the contact summary actions **"Set to Inactive"** or the API function: **Contact.setinactive**
13+
Either via the contact summary actions **"Set to Inactive"** or the API function
14+
**Contact.setinactive**

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

mkdocs.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
site_name: CiviCRM Contact Inactive Extension
2+
repo_url: https://github.com/systopia/de.systopia.contactinactive
3+
theme: material
4+
5+
pages:
6+
- 'Home': index.md
7+
8+
markdown_extensions:
9+
- attr_list
10+
- admonition
11+
- def_list
12+
- codehilite
13+
- toc:
14+
permalink: true
15+
- pymdownx.superfences
16+
- pymdownx.inlinehilite
17+
- pymdownx.tilde
18+
- pymdownx.betterem
19+
- pymdownx.mark

0 commit comments

Comments
 (0)