Neat Paraskavedekatriaphobia's Meaning

    mxdocgen
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    Welcome to mxdocgen 👋

    Version Documentation Maintenance License: ISC

    A small tool that mimics the documentation generation capabilities offered in Mendix Studio Pro, but with greater flexibility.

    It uses the Mendix Model SDK to extract information from a Mendix model, which is then fed into a set of templates to generate the required output, such as an .html document. Filters can be applied to control which modules and documents should be processed.

    The tool can be used as a standalone (node-based) CLI or as a library.

    🏠 Homepage

    Demo

    Install

    npm install

    Usage

    Library

    API docs

    CLI

    npx mxdocgen

    or, during development

    npm run start

    Command line parameters

    Without a command
    mxdocgen <command>
    
    Commands:
      mxdocgen copy-templates <target>  Copy the default templates to another location
                                      for modification
      mxdocgen generate                 Generate documentation
    
    Options:
      --help     Show help                                                 [boolean]
      --version  Show version number                                       [boolean]
      --config   Path to JSON config file
    
    Generate
    mxdocgen generate
    
    Generate documentation
    
    Credentials:
      --username                                                 [string] [required]
      --apikey                                                   [string] [required]
    
    Filters:
      --modules                                             [string] [default: ".*"]
      --ignore                                             [array] [default: ["**"]]
    
    Output:
      --outputdir                            [string] [required] [default: "output"]
      --outputfile                       [string] [required] [default: "index.html"]
    
    Project:
      --mpk                                                                 [string]
      --projectid                                                           [string]
      --revision                                                            [number]
      --branch                                                              [string]
      --workingcopyid                                                       [string]
    
    Templates:
      --templatedir                                                         [string]
      --templateext                                                         [string]
      --maintemplate                                                        [string]
    
    Options:
      --help     Show help                                                 [boolean]
      --version  Show version number                                       [boolean]
      --config   Path to JSON config file
    
    Copy templates
    mxdocgen copy-templates <target>
    
    Copy the default templates to another location for modification
    
    Options:
      --help     Show help                                                 [boolean]
      --version  Show version number                                       [boolean]
      --config   Path to JSON config file
      --target   Target directory for the templates                         [string]
    

    Author

    👤 Kevin Vlaanderen

    🤝 Contributing

    Contributions, issues and feature requests are welcome!
    Feel free to check issues page.

    Show your support

    Give a ⭐️ if this project helped you!

    📝 License

    Copyright © 2020 Kevin Vlaanderen.

    This project is ISC licensed.


    This README was generated with ❤️ by readme-md-generator

    Install

    npm i mxdocgen

    DownloadsWeekly Downloads

    8

    Version

    1.2.1

    License

    ISC

    Unpacked Size

    178 kB

    Total Files

    100

    Last publish

    Collaborators

    • kevinvl