@grafana/api-documenter - npm Package Compare versions

Comparing version 0.9.0 to 0.9.1

lib/nodes/grafana/DocFrontMatter.js

@@ -18,2 +18,5 @@ "use strict";
         writer.writeLine(DocFrontMatter._tag);
+        writer.writeLine('# -----------------------------------------------------------------------');
+        writer.writeLine('# Do not edit this file. It is automatically generated by API Documenter.');
+        writer.writeLine('# -----------------------------------------------------------------------');
         writer.writeLine(`title = "${this._title}"`);
@@ -20,0 +23,0 @@ writer.writeLine(`keywords = [${keywords}]`);

package.json

 {
   "name": "@grafana/api-documenter",
-  "version": "0.9.0",
+  "version": "0.9.1",
   "description": "Read JSON files from api-extractor, generate documentation pages",
@@ -5,0 +5,0 @@ "repository": {

README.md

@@ -13,1 +13,8 @@ # @microsoft/api-documenter
 API documentation for this package: https://rushstack.io/pages/api/api-documenter/
+
+# Extended with some special Grafana extras
+
+When running the tool with the markdown option you can specify two more flags:
+
+- `--hugo` that will export the markdown in a hugo friendly format with FrontMatter meta data included.
+- `--draft` that will make the documentation as draft (it will not be visible when running Hugo in production).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

829518

increased by0.13%

Lines of code

11453

increased by0.03%

Number of lines in readme file

19

increased by46.15%

No dependency changes