PSRyver/mkdocs.yml at master · tlindsay42/PSRyver · GitHub

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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# https://www.mkdocs.org/user-guide/configuration/

# Project information
site_name: 'PSRyver'
site_description: 'Community PowerShell module for the Ryver API.'
site_author: 'Troy Lindsay'
site_url: 'https://tlindsay42.github.io/PSRyver/'

# Repository
repo_name: 'tlindsay42/PSRyver'
repo_url: 'https://github.com/tlindsay42/PSRyver'
remote_branch: 'gh-pages'
edit_uri: 'blob/master/docs/'

# Copyright
copyright: 'Copyright &copy;2018 Troy Lindsay. All rights reserved.<br>Copyright &copy;2016-2018 Warren F. All rights reserved.'

# Google Analytics
google_analytics: ['UA-117909744-4', 'PSRyver']

# Configuration
theme:
  name: 'material'

  # 404 page
  static_templates:
  - '404.html'

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: false

  # Default values, taken from mkdocs_theme.yml
  language: 'en'
  feature:
    tabs: false
  palette:
    primary: 'blue grey'
    accent: 'blue'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'
  favicon: 'img/ryver-favicon1.png'
  logo: 'img/ryver-favicon1.png'

# Customization
extra:
  social:
  - type: 'globe'
    link: 'https://www.troylindsay.io'
  - type: 'github-alt'
    link: 'https://github.com/tlindsay42'
  - type: 'twitter'
    link: 'https://twitter.com/troylindsay42'
  - type: 'linkedin'
    link: 'https://www.linkedin.com/in/troylindsay'

# Extensions
markdown_extensions:
- admonition
- markdown.extensions.codehilite:
    guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
    permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
    smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
    emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
    custom_checkbox: true
- pymdownx.tilde

# Page tree
pages:
- Home: 'index.md'
- Cmdlet Documentation:
  - Export-PSRyverConfig: 'Public/Export-PSRyverConfig.md'
  - Find-RyverAttachment: 'Public/Find-RyverAttachment.md'
  - Find-RyverMessage: 'Public/Find-RyverMessage.md'
  - Find-RyverTask: 'Public/Find-RyverTask.md'
  - Find-RyverTaskComment: 'Public/Find-RyverTaskComment.md'
  - Find-RyverTopic: 'Public/Find-RyverTopic.md'
  - Find-RyverTopicComment: 'Public/Find-RyverTopicComment.md'
  - Get-PSRyverConfig: 'Public/Get-PSRyverConfig.md'
  - Get-PSRyverConfigPath: 'Public/Get-PSRyverConfigPath.md'
  - Get-RyverForum: 'Public/Get-RyverForum.md'
  - Get-RyverHistory: 'Public/Get-RyverHistory.md'
  - Get-RyverTeam: 'Public/Get-RyverTeam.md'
  - Get-RyverUser: 'Public/Get-RyverUser.md'
  - Import-PSRyverConfig: 'Public/Import-PSRyverConfig.md'
  - Initialize-PSRyverConfig: 'Public/Initialize-PSRyverConfig.md'
  - Invoke-RyverRestMethod: 'Public/Invoke-RyverRestMethod.md'
  - Read-PSRyverConfig: 'Public/Read-PSRyverConfig.md'
  - Remove-PSRyverConfig: 'Public/Remove-PSRyverConfig.md'
  - Remove-RyverMessage: 'Public/Remove-RyverMessage.md'
  - Send-RyverMessage: 'Public/Send-RyverMessage.md'
  - Set-PSRyverConfig: 'Public/Set-PSRyverConfig.md'
  - Set-PSRyverConfigPath: 'Public/Set-PSRyverConfigPath.md'
- Private Functions:
  - Assert-RyverApiConfig: 'Private/Assert-RyverApiConfig.md'
  - Convert-ColorToHexTriplet: 'Private/Convert-ColorToHexTriplet.md'
  - ConvertFrom-UnixTime: 'Private/ConvertFrom-UnixTime.md'
  - ConvertTo-Authorization: 'Private/ConvertTo-Authorization.md'
  - ConvertTo-UnixTime: 'Private/ConvertTo-UnixTime.md'
  - Format-RyverAttachmentObject: 'Private/Format-RyverAttachmentObject.md'
  - Format-RyverChannelObject: 'Private/Format-RyverChannelObject.md'
  - Format-RyverMessageObject: 'Private/Format-RyverMessageObject.md'
  - Format-RyverTaskCommentObject: 'Private/Format-RyverTaskCommentObject.md'
  - Format-RyverTaskObject: 'Private/Format-RyverTaskObject.md'
  - Format-RyverTopicCommentObject: 'Private/Format-RyverTopicCommentObject.md'
  - Format-RyverTopicObject: 'Private/Format-RyverTopicObject.md'
  - Format-RyverUserObject: 'Private/Format-RyverUserObject.md'
  - Remove-SensitiveData: 'Private/Remove-SensitiveData.md'
  - Test-IsWindows: 'Private/Test-IsWindows.md'