Introduction

Installation

For full documentation visit mkdocs.org.

Description

With the help of MkDocs you can create and develop documentation on ObjectMappers API.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Project Structure

1
mkdocs.yml # Configuration file.
2
docs/
3
index.md # Documentation homepage
4
modules/
5
beancp/
6
info.md
7
beanmapper/
8
info.md
9
beanutils/
10
info.md
11
bull/
12
info.md
13
converter/
14
info.md
15
datus/
16
info.md
17
doov/
18
info.md
19
dozer/
20
info.md
21
jmapper/
22
info.md
23
mapstruct/
24
info.md
25
modelmapper/
26
info.md
27
moo/
28
info.md
29
nomin/
30
info.md
31
orika/
32
info.md
33
remap/
34
info.m
35
selma/
36
info.md
37
smooks/
38
info.md
39
user-guide/
40
changelog.md # Changelog page
41
code_of_conduct.md # Code of conduct page
42
code_owners.md # Code owners page
43
dependency.md # Dependency page
44
description.md # Description page
45
faq.md # FAQ page
46
getting-started.md # Getting started page
47
troubleshooting.md # Troubleshooting page
48
how-to-move-content.md # Cloning project content page
49
upgrade.md # Upgrade project page
50
reporting/
51
info.md # Informational page
52
issue_template.md # Issue template page
53
bug_report.md # Bug report template
54
custom_report.md # Custom report template
55
feature_request_template.md # Feature request template
56
pull_request_template.md # Pull request template
57
contributing/
58
info.md # Contribution page
59
links/
60
info.md # Contribution page
Copied!
Last modified 3mo ago