datafaker/mkdocs.yml at main · datafaker-net/datafaker · 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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
site_name: Datafaker
site_url: https://www.datafaker.net
site_author: Erik Pragt
site_description: >-
  Create fake data for your JVM programs within minutes,
  using our wide range of more than 250 data providers

repo_name: datafaker-net/datafaker
repo_url: https://github.com/datafaker-net/datafaker
edit_uri: "edit/main/docs"

# Copyright
copyright: Copyright &copy; 2016 - 2026 Erik Pragt

theme:
  name: material
  custom_dir: material
  favicon: assets/images/favicon.png
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - content.action.edit
    # - content.tabs.link
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    - navigation.footer
    # - navigation.sections  # disabled: prevents collapsible 2.x/1.x release groups in Material 9
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    # - toc.integrate

extra_css:
  - stylesheets/extra.css

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: datafaker-net
      repo: datafaker
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search
  - allscreenshots-og-screenshot
  - macros
  - minify:
      minify_html: true

# Files to exclude from the built site
exclude_docs: |
  releases/.RELEASE-template.md
  releases/.SNAPSHOT-template.md
  releases/*-SNAPSHOT.md

# Customization
extra:
  datafaker:
    version: 2.7.0
    snapshot: 2.8.0-SNAPSHOT

# Page tree
nav:
  - Home: index.md
  - Documentation:
    - Getting started: documentation/getting-started.md
    - Basic usage: documentation/usage.md
    - Data providers:
      - All providers: documentation/providers.md
      - Custom providers: documentation/custom-providers.md
    - Advanced usage:
      - Sequences: documentation/sequences.md
      - Date format: documentation/date-format.md
      - Advanced password generation: documentation/password.md
      - Expressions: documentation/expressions.md
      - Formats: documentation/formats.md
      - Transformation schemas: documentation/schemas.md
      - Unique values: documentation/unique-values.md
    - Performance:
      - Datafaker 1.4.0: documentation/performance140.md
      - Datafaker 1.7.0: documentation/performance170.md
    - Javadoc: 'https://javadoc.io/doc/net.datafaker/datafaker/latest/index.html'
    - Contributing: documentation/contributing.md
    - First time contributor: documentation/first-time-contributor.md
    - License: documentation/license.md
#    - Changelog:
#      - Changes: changelog/index.md
#      - How to upgrade: upgrade.md
  - Releases:
    - 2.8.0-SNAPSHOT: releases/2.8.0-SNAPSHOT.md
    - 2.7.0: releases/2.7.0.md
    - 2.x:
      - 2.6.0: releases/2.6.0.md
      - 2.5.4: releases/2.5.4.md
      - 2.5.3: releases/2.5.3.md
      - 2.5.2: releases/2.5.2.md
      - 2.5.1: releases/2.5.1.md
      - 2.5.0: releases/2.5.0.md
      - 2.4.4: releases/2.4.4.md
      - 2.4.3: releases/2.4.3.md
      - 2.4.2: releases/2.4.2.md
      - 2.4.1: releases/2.4.1.md
      - 2.4.0: releases/2.4.0.md
      - 2.3.1: releases/2.3.1.md
      - 2.3.0: releases/2.3.0.md
      - 2.2.2: releases/2.2.2.md
      - 2.2.1: releases/2.2.1.md
      - 2.2.0: releases/2.2.0.md
      - 2.1.0: releases/2.1.0.md
      - 2.0.2: releases/2.0.2.md
      - 2.0.1: releases/2.0.1.md
      - 2.0.0: releases/2.0.0.md
    - 1.x:
      - 1.9.0: releases/1.9.0.md
      - 1.8.0: releases/1.8.0.md
      - 1.7.0: releases/1.7.0.md
      - 1.6.0: releases/1.6.0.md
      - 1.5.0: releases/1.5.0.md
      - 1.4.0: releases/1.4.0.md
      - 1.3.0: releases/1.3.0.md
      - 1.2.0: releases/1.2.0.md
      - 1.1.0: releases/1.1.0.md
      - 1.0.0: releases/1.0.0.md
      - 0.9.0: releases/0.9.0.md
  - In the news: in-the-media/links.md