@tinymce/moxiedoc - npm Package Compare versions

Comparing version 0.2.2-feature.20220711080318333.sha1e32633 to 0.2.2-feature.20220712010039247.sha1f5d4f4

CHANGELOG.md

@@ -9,2 +9,7 @@ # Changelog
 
+## 0.2.2 - 2022-07-12
+
+### Added
+- New `structure` option with default `flat` file structure or `legacy` nested folders.
+
 ## 0.2.1 - 2022-04-29
@@ -11,0 +16,0 @@

dist/lib/cli.js

@@ -9,6 +9,6 @@ #! /usr/bin/env node
 commander_1.program
-    .version('0.2.0')
+    .version('0.2.2')
     .usage('[options] <dir ...>')
     .option('-o, --out <path>', 'output path, default: out')
-    .option('-t, --template <template>', 'template name')
+    .option('-t, --template <template>', 'template name, default: cli')
     .option('-s, --structure <type>', 'output file structure, default: flat')
@@ -15,0 +15,0 @@ .option('-v, --verbose', 'verbose output')

package.json

 {
   "name": "@tinymce/moxiedoc",
-  "version": "0.2.2-feature.20220711080318333.sha1e32633",
+  "version": "0.2.2-feature.20220712010039247.sha1f5d4f4",
   "description": "A tool for generating API documentation",
@@ -5,0 +5,0 @@ "author": "Tiny Technologies, Inc",

README.md

 # 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: 'flat', '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:
+
 ```json
@@ -4,0 +35,0 @@ {

src/lib/cli.ts

@@ -11,6 +11,6 @@ #! /usr/bin/env node
 program
-  .version('0.2.0')
+  .version('0.2.2')
   .usage('[options] <dir ...>')
   .option('-o, --out <path>', 'output path, default: out')
-  .option('-t, --template <template>', 'template name')
+  .option('-t, --template <template>', 'template name, default: cli')
   .option('-s, --structure <type>', 'output file structure, default: flat')
@@ -17,0 +17,0 @@ .option('-v, --verbose', 'verbose output')

No alert changes

Improved metrics

Total package byte prevSize

352972

increased by0.35%

Number of lines in readme file

65

increased by91.18%

No dependency changes