Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@tinymce/moxiedoc

Package Overview
Dependencies
Maintainers
2
Versions
82
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@tinymce/moxiedoc

A tool for generating API documentation

  • 0.3.0
  • latest
  • release-0.3
  • Source
  • npm
  • Socket score

Version published
Maintainers
2
Created
Source

moxiedoc

Introduction

This project maintains Moxiedoc, a tool used to build API reference documentation. If you have any modifications you wish to contribute, fork this project, make the changes and submit a pull request. You will need to sign the contributors license agreement, which will be emailed to you upon creating the pull request.

Using Moxiedoc

To create API reference documentation from a development version of moxiedoc, run:

yarn build
node ./dist/lib/cli.js PATH/TO/API_FILE_FOLDER

Moxiedoc Options

Moxiedoc provides the following options to customise the format of the output documentation:

-o --out <path>: location of output files, default: 'tmp/out.zip'
-t --template <template>: documentation type: default: 'cli'; 'antora', 'github', 'moxiewiki', 'singlehtml', 'tinymcenext', 'xml'
-s --structure <type>: default: 'default'; 'legacy'
-v --verbose: verbose output
--debug: debug output
--dry: dry run only syntax check
--fail-on-warning: fail if warnings are produced

Schema

The output JSON takes the form of the following schema:

{
  "namespace.Class": {
    "type": "class|enum|struct|mixin|interface",
    "members": [
      {
        "type": "method|field|property|event|constant|callback",
        "static": true,
        "abstract": true,
        "name": "doStuff",
        "access": "private|protected|internal|public",
        "extends": "namespace.Class",
        "implements": ["namespace.Interface"],
        "deprecated": "Text about deprecation",
        "description": "Do stuff",
        "mixes": ["namespace.Class1", "namespace.Class2"],
        "examples": [
          {"text": "Some example"},
          {"caption": "Some example", "text": "Some example"}
        ],
        "params": [
          {"name": "mystuff", "type": "string", "description": "My stuff"}
        ],
        "returns": {
          {"type": "string", "description": "Returns string."}
        }
      }
    ]
  }
}

Keywords

FAQs

Package last updated on 11 Apr 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc