docsalot 0.1.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CONTRIBUTING.md +3 -0
- package/README.md +78 -0
- package/index.js +3 -0
- package/package.json +37 -0
package/CONTRIBUTING.md
ADDED
package/README.md
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<a href="https://mintlify.com">
|
|
3
|
+
<img
|
|
4
|
+
src="https://res.cloudinary.com/mintlify/image/upload/v1665385627/logo-rounded_zuk7q1.svg"
|
|
5
|
+
alt="Mintlify Logo"
|
|
6
|
+
height="64"
|
|
7
|
+
/>
|
|
8
|
+
</a>
|
|
9
|
+
<br />
|
|
10
|
+
<p>
|
|
11
|
+
<h3>
|
|
12
|
+
<b>
|
|
13
|
+
Mintlify CLI
|
|
14
|
+
</b>
|
|
15
|
+
</h3>
|
|
16
|
+
</p>
|
|
17
|
+
<p>
|
|
18
|
+
The Mintlify CLI is the easiest way to build Mintlify apps from the command line.
|
|
19
|
+
</p>
|
|
20
|
+
<p>
|
|
21
|
+
|
|
22
|
+
[](/) [](https://mintlify.com) [](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml) [](https://twitter.com/intent/tweet?url=&text=Check%20out%20%40mintlify) [](https://discord.gg/MPNgtSZkgK) [](https://github.com/mintlify/mint/discussions)
|
|
23
|
+
|
|
24
|
+
</p>
|
|
25
|
+
<p>
|
|
26
|
+
<sub>
|
|
27
|
+
Built with ❤︎ by
|
|
28
|
+
<a href="https://mintlify.com">
|
|
29
|
+
Mintlify
|
|
30
|
+
</a>
|
|
31
|
+
</sub>
|
|
32
|
+
</p>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
### 🚀 Installation
|
|
36
|
+
|
|
37
|
+
Download the Mintlify CLI using the following command
|
|
38
|
+
|
|
39
|
+
```
|
|
40
|
+
npm i -g mintlify
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### 👩💻 Development
|
|
44
|
+
|
|
45
|
+
Run the following command at the root of your Mintlify application to preview changes locally.
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
mintlify dev
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Note - `mintlify dev` requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install --global yarn` in your terminal.
|
|
52
|
+
|
|
53
|
+
### Custom Ports
|
|
54
|
+
|
|
55
|
+
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:
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
mintlify dev --port 3333
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
You will see an error like this if you try to run Mintlify in a port that's already taken:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
Error: listen EADDRINUSE: address already in use :::3000
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
#### Troubleshooting
|
|
68
|
+
|
|
69
|
+
Steps you can take if the dev CLI is not working (After each step try to run `mintlify dev` again):
|
|
70
|
+
|
|
71
|
+
- Make sure you are running in a folder with a `mint.json` file.
|
|
72
|
+
- Make sure you are using Node v18 or higher.
|
|
73
|
+
- Run `mintlify install` to re-install dependencies.
|
|
74
|
+
- Navigate to the `.mintlify` folder in your home directory and delete its contents.
|
|
75
|
+
|
|
76
|
+
### 🏃 Get Started
|
|
77
|
+
|
|
78
|
+
[Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.
|
package/index.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "docsalot",
|
|
3
|
+
"version": "0.1.0-beta.0",
|
|
4
|
+
"description": "Alias for @docsalot/cli",
|
|
5
|
+
"engines": {
|
|
6
|
+
"node": ">=18.0.0"
|
|
7
|
+
},
|
|
8
|
+
"author": "SlashML Corp.",
|
|
9
|
+
"homepage": "https://github.com/slashml/docsalot",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "https://github.com/slashml/docsalot",
|
|
13
|
+
"directory": "packages/docsalot"
|
|
14
|
+
},
|
|
15
|
+
"bugs": {
|
|
16
|
+
"url": "https://github.com/slashml/docsalot/issues"
|
|
17
|
+
},
|
|
18
|
+
"license": "Elastic-2.0",
|
|
19
|
+
"keywords": [
|
|
20
|
+
"docsalot",
|
|
21
|
+
"docs",
|
|
22
|
+
"documentation",
|
|
23
|
+
"cli"
|
|
24
|
+
],
|
|
25
|
+
"type": "module",
|
|
26
|
+
"publishConfig": {
|
|
27
|
+
"access": "public",
|
|
28
|
+
"registry": "https://registry.npmjs.org/"
|
|
29
|
+
},
|
|
30
|
+
"bin": {
|
|
31
|
+
"docsalot": "index.js"
|
|
32
|
+
},
|
|
33
|
+
"dependencies": {
|
|
34
|
+
"@docsalot/cli": "0.1.0-beta.0",
|
|
35
|
+
"@docsalot/previewing": "0.1.0-beta.0"
|
|
36
|
+
}
|
|
37
|
+
}
|