📓
Object-Mappers-Docs
  • Introduction
  • contributing
    • Contributing
  • links
    • Resources
  • reporting
    • Bug Report
    • Custom Report
    • Feature Request Template
    • General Information
    • Issue Report
    • Pull Request Template
  • user-guide
    • Changelog
    • Code of Conduct
    • Code Owners
    • Dependency Management
    • FAQ
    • Getting Started
    • Repositories: How to move content from one repository to another one
    • Troubleshooting
    • Upgrading
  • modules
    • beancp
      • BeanCP Tutorial
    • beanmapper
      • BeanMapper Tutorial
    • beanutils
      • BeanUtils Tutorial
    • bull
      • Bull Tutorial
    • converter
      • Converter Tutorial
    • datus
      • Datus Tutorial
    • doov
      • Doov Tutorial
    • dozer
      • Dozer Tutorial
    • jmapper
      • JMapper Tutorial
    • mapstruct
      • MapStruct Tutorial
    • modelmapper
      • ModelMapper Tutorial
    • moo
      • Moo Tutorial
    • nomin
      • Nomin Tutorial
    • orika
      • Orika Tutorial
    • remap
      • ReMap Tutorial
    • selma
      • Selma Tutorial
    • smooks
      • Smooks Tutorial
Powered by GitBook
On this page
  • Installation
  • Description
  • Commands
  • Project Structure

Was this helpful?

Introduction

Nextcontributing

Last updated 3 years ago

Was this helpful?

Installation

For full documentation visit .

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

mkdocs.yml    # Configuration file.
docs/
    index.md  # Documentation homepage
    modules/
        beancp/
            info.md
        beanmapper/
            info.md
        beanutils/
            info.md
        bull/
            info.md
        converter/
            info.md
        datus/
            info.md
        doov/
            info.md
        dozer/
            info.md
        jmapper/
            info.md
        mapstruct/
            info.md
        modelmapper/
            info.md
        moo/
            info.md
        nomin/
            info.md
        orika/
            info.md
        remap/
            info.m
        selma/
            info.md
        smooks/
            info.md
    user-guide/
        changelog.md # Changelog page 
        code_of_conduct.md # Code of conduct page 
        code_owners.md # Code owners page 
        dependency.md # Dependency page 
        description.md # Description page
        faq.md # FAQ page
        getting-started.md # Getting started page
        troubleshooting.md # Troubleshooting page
        how-to-move-content.md # Cloning project content page
        upgrade.md # Upgrade project page
    reporting/
        info.md # Informational page
        issue_template.md # Issue template page
        bug_report.md # Bug report template
        custom_report.md # Custom report template
        feature_request_template.md # Feature request template
        pull_request_template.md # Pull request template
    contributing/
        info.md # Contribution page
    links/
        info.md # Contribution page
mkdocs.org