mint 0.3.5 → 4.1.1

package/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Mint CLI
+
+`mint` is an alias for [@mintlify/cli](https://www.npmjs.com/package/@mintlify/cli).

package/LICENSE

@@ -0,0 +1,93 @@
+Copyright (c) 2022 Mintlify, Inc.
+
+Elastic License 2.0
+
+## Acceptance
+
+By using the software, you agree to all of the terms and conditions below.
+
+## Copyright License
+
+The licensor grants you a non-exclusive, royalty-free, worldwide,
+non-sublicensable, non-transferable license to use, copy, distribute, make
+available, and prepare derivative works of the software, in each case subject to
+the limitations and conditions below.
+
+## Limitations
+
+You may not provide the software to third parties as a hosted or managed
+service, where the service provides users with access to any substantial set of
+the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality
+in the software, and you may not remove or obscure any functionality in the
+software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices
+of the licensor in the software. Any use of the licensor’s trademarks is subject
+to applicable law.
+
+## Patents
+
+The licensor grants you a license, under any patent claims the licensor can
+license, or becomes able to license, to make, have made, use, sell, offer for
+sale, import and have imported the software, in each case subject to the
+limitations and conditions in this license. This license does not cover any
+patent claims that you cause to be infringed by modifications or additions to
+the software. If you or your company make any written claim that the software
+infringes or contributes to infringement of any patent, your patent license for
+the software granted under these terms ends immediately. If your company makes
+such a claim, your patent license ends immediately for work on behalf of your
+company.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you
+also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the
+software prominent notices stating that you have modified the software.
+
+## No Other Rights
+
+These terms do not imply any licenses other than those expressly granted in
+these terms.
+
+## Termination
+
+If you use the software in violation of these terms, such use is not licensed,
+and your licenses will automatically terminate. If the licensor provides you
+with a notice of your violation, and you cease all violation of this license no
+later than 30 days after you receive that notice, your licenses will be
+reinstated retroactively. However, if you violate these terms after such
+reinstatement, any additional violation of these terms will cause your licenses
+to terminate automatically and permanently.
+
+## No Liability
+
+_As far as the law allows, the software comes as is, without any warranty or
+condition, and the licensor will not be liable to you for any damages arising
+out of these terms or the use or nature of the software, under any kind of
+legal claim._
+
+## Definitions
+
+The **licensor** is the entity offering these terms, and the **software** is the
+software the licensor makes available under these terms, including any portion
+of it.
+
+**you** refers to the individual or entity agreeing to these terms.
+
+**your company** is any legal entity, sole proprietorship, or other kind of
+organization that you work for, plus all organizations that have control over,
+are under the control of, or are under common control with that
+organization. **control** means ownership of substantially all the assets of an
+entity, or the power to direct its management and policies by vote, contract, or
+otherwise. Control can be direct or indirect.
+
+**your licenses** are all the licenses granted to you for the software under
+these terms.
+
+**use** means anything you do with the software requiring one of your licenses.
+
+**trademark** means trademarks, service marks, and similar rights.

package/README.md

@@ -1,126 +1,93 @@
-# Mint.js
+<div align="center">
+  <a href="https://mintlify.com">
+    <img
+      src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
+      alt="Mintlify Logo"
+      height="64"
+    />
+  </a>
+  <br />
+  <p>
+    <h3>
+      <b>
+        Mint CLI
+      </b>
+    </h3>
+  </p>
+  <p>
+    The Mint CLI is the easiest way to build Mintlify apps from the command line.
+  </p>
+  <p>
+
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Tweet](https://img.shields.io/twitter/url?url=https%3A%2F%2Fmintlify.com%2F)](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify)
+[![Discuss on Slack](https://img.shields.io/badge/chat-on%20Slack-blueviolet)](https://mintlify.com/community)
+
+  </p>
+  <p>
+    <sub>
+      Built with ❤︎ by
+      <a href="https://mintlify.com">
+        Mintlify
+      </a>
+    </sub>
+  </p>
+</div>
+
+### Installation
+
+Download the Mint CLI using the following command
 
-> Standard Interface to the Node.js Template Engines (JavaScript, CSS, text, etc.).
-
-[![Build Status](https://secure.travis-ci.org/viatropos/mint.png)](http://travis-ci.org/viatropos/mint)
-
-## Install
-
-``` bash
-npm install mint
 ```
-
-## Engines
-
-``` coffeescript
-mint = require("mint")
-mint.coffee
-mint.coffeekup
-mint.eco
-mint.ejs
-mint.haml
-mint.hamlcoffee
-mint.handlebars
-mint.jade
-mint.less
-mint.stylus
-mint.markdown
-mint.mustache
-mint.uglifyjs
-mint.yui
+npm i -g mint
 ```
 
-## Example
+### Development
 
-``` coffeescript
-mint     = require('mint')
-mint.mustache "{title}!", locals: title: "Hello World", (string) -> console.log(string) #=> "Hello World!"
-```
+#### `mint dev`
 
-or more formally:
+Run this command at the root of your Mintlify project to preview changes locally.
 
-``` coffeescript
-input     = fs.readFileSync("./test/fixtures/views/jade.jade", "utf-8")
-output    = fs.readFileSync("./test/fixtures/views/jade.html", "utf-8")
-mint.jade input, {}, (error, result) ->
-  assert.equal result, output
-```
+Notes
 
-or if you want just to compile a template(**Note**: supports only jade, haml, handlebars, eco, ejs):
+- `mint dev` requires Node v18 or higher.
 
-``` coffeescript
-fn = mint.compile template: input, engine: 'jade' # Function
-fn title: 'Title', author: 'Some author' # String, rendered template
-```
+#### Custom Ports
 
-## API
+Mintlify uses port 3000 by default. You can use the `--port` flag to customize the port Mintlify runs on. For example, use this command to run in port 3333:
 
-``` coffeescript
-mint[engine](string, options, callback)
+```
+mint dev --port 3333
 ```
 
-## Preprocessing
-
-Sometimes you might need to hack in a feature to the language.  Like right now, stylus doesn't support multiline values for css attributes, so you might add it like this:
-
-``` coffeescript
-input   = '''
-div
-  box-shadow: 0 -2px 2px  hsl(220, 20%, 40%),
-    0 -10px 10px          hsl(220, 20%, 20%),
-    0 0 15px              black,
-
-    inset 0 5px 1px       hsla(220, 80%, 10%, 0.4), 
-    inset 0 0 5px         hsla(220, 80%, 10%, 0.1),
-    inset 0 20px 15px     hsla(220, 80%, 100%, 1),
-
-    inset 0 1px 0         hsl(219, 20%, 0%), 
-
-    inset 0 -50px 50px -40px hsla(220, 80%, 10%, .3),  /* gradient to inset */
-
-    inset 0 -1px 0px      hsl(220, 20%, 20%),
-    inset 0 -2px 0px      hsl(220, 20%, 40%),
-    inset 0 -2px 1px      hsl(220, 20%, 65%)  
-'''
+You will see an error like this if you try to run Mintlify in a port that's already taken:
 
-output  = '''
-div {
-  box-shadow: 0 -2px 2px #525f7a, 0 -10px 10px #29303d, 0 0 15px #000, inset 0 5px 1px rgba(5,19,46,0.40), inset 0 0 5px rgba(5,19,46,0.10), inset 0 20px 15px #fff, inset 0 1px 0 #000, inset 0 -50px 50px -40px rgba(5,19,46,0.30), inset 0 -1px 0px #29303d, inset 0 -2px 0px #525f7a, inset 0 -2px 1px #94a0b8;
-}
+```
+Error: listen EADDRINUSE: address already in use :::3000
+```
 
-'''
-# locally
-options   =
-  preprocessor: (content) ->
-    content.replace /(\s+)(.*),\s+(?:\/\*.*\*\/)?\s*/mg, (_, indent, attribute) ->
-      "#{indent}#{attribute.replace(/\s+/g, " ")}, "
+#### Troubleshooting
 
-mint.stylus input, options, (error, result) ->
-  expect(result).toEqual output
+Steps you can take if the dev CLI is not working (After each step try to run `mint dev` again):
 
-# globally
-mint.stylus.preprocessor = (content) ->
-  content.replace /(\s+)(.*),\s+(?:\/\*.*\*\/)?\s*/mg, (_, indent, attribute) ->
-    "#{indent}#{attribute.replace(/\s+/g, " ")}, "
+- Make sure you are running in a folder with a `docs.json` file.
+- Run `npm update -g mint` to ensure you have the most recent version of the CLI.
+- Make sure you are using Node v18 or higher.
+- Navigate to the `.mintlify` folder in your home directory and delete its contents.
 
-mint.stylus input, {}, (error, result) ->
-  expect(result).toEqual output
-```
+### Additional Commands
 
-## Test
+#### `mint broken-links`
 
-``` bash
-mocha
-```
+Check for broken internal links in your Mintlify project.
 
-## License
+#### `mint rename <from> <to>`
 
-(The MIT License)
+Rename a file in a Mintlify project and update all internal link references.
 
-Copyright &copy; 2011 [Lance Pollard](http://twitter.com/viatropos) &lt;lancejpollard@gmail.com&gt;
+#### `mint openapi-check <openapiFilenameOrUrl>`
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Check your OpenAPI file for errors. You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`).
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+### Get Started
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.

package/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import { cli as _ } from '@mintlify/cli';

package/package.json

@@ -1,55 +1,37 @@
 {
   "name": "mint",
-  "version": "0.3.5",
-  "description": "Template abstraction framework",
-  "homepage": "http://github.com/viatropos/mint.js",
-  "main": "mint.js",
-  "author": "Lance Pollard <lancejpollard@gmail.com>",
+  "version": "4.1.1",
+  "description": "The Mintlify CLI",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "author": "Mintlify, Inc.",
+  "bugs": {
+    "url": "https://github.com/orgs/mintlify/discussions"
+  },
+  "license": "Elastic-2.0",
   "keywords": [
-    "framework",
-    "compression",
-    "node"
-  ],
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "http://mths.be/mit"
-    }
+    "mintlify",
+    "mint",
+    "cli"
   ],
-  "bugs": {
-    "url": "https://github.com/viatropos/mint.js/issues"
+  "type": "module",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/viatropos/mint.js.git"
+  "bin": {
+    "mint": "index.js",
+    "mintlify": "index.js"
   },
-  "engines": {
-    "node": ">= 0.4.0"
+  "scripts": {
+    "clean:all": "rimraf node_modules"
   },
   "dependencies": {
-
+    "@mintlify/cli": "4.0.518"
   },
   "devDependencies": {
-    "coffee-script":      ">= 1.3.1",
-    "uglify-js":          ">= 1.1.1",
-    "clean-css":          ">= 0.3.2",
-    "mocha":              ">= 0.8.1",
-    "should":             ">= 0.3.x",
-    "chai":               ">= 0.3.3",
-    "sinon":              ">= 1.3.1",
-    "stylus":             ">= 0.17.0",
-    "less":               ">= 1.2.x",
-    "ejs":                ">= 0.6.1",
-    "coffeekup":          ">= 0.3.1",
-    "jade":               ">= 0.20.x",
-    "haml":               ">= 0.4.x",
-    "hamljs":             ">= 0.6.x",
-    "haml-coffee":        ">= 0.5.0",
-    "mustache":           ">= 0.4.x",
-	  "handlebars":		      "*",
-	  "eco":				        "*"
+    "rimraf": "^5.0.1"
   },
-  "scripts": {
-    "test": "node_modules/mocha/bin/mocha $(find test -name \"*Test.coffee\")"
-  }
+  "gitHead": "85eaab3d2e1cd92e6db01cb1a21962f986ca1367"
 }

package/.npmignore

@@ -1,11 +0,0 @@
-*.coffee
-*.html
-.DS_Store
-.git*
-Cakefile
-wiki/
-examples/
-src/
-spec/
-favicon.ico
-Watchfile

package/.travis.yml

@@ -1,4 +0,0 @@
-language: node_js
-node_js:
-  - 0.4
-  - 0.6

package/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2011-2012 Lance Pollard <lancejpollard@gmail.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.