docsalot 0.1.0-beta.1 → 0.1.0-beta.3

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.
Files changed (3) hide show
  1. package/CONTRIBUTING.md +2 -2
  2. package/README.md +14 -65
  3. package/package.json +4 -12
package/CONTRIBUTING.md CHANGED
@@ -1,3 +1,3 @@
1
- # Mintlify CLI
1
+ # DocsALot CLI
2
2
 
3
- `mintlify` is a wrapper for [@mintlify/cli](https://www.npmjs.com/package/@mintlify/cli).
3
+ `docsalot` is a wrapper for [@docsalot/cli](https://www.npmjs.com/package/@docsalot/cli).
package/README.md CHANGED
@@ -1,78 +1,27 @@
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>
1
+ # docsalot
21
2
 
22
- [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)](/) [![Website](https://img.shields.io/website?url=https%3A%2F%2Fmintlify.com&logo=mintlify)](https://mintlify.com) [![Unit Tests](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml/badge.svg)](https://github.com/mintlify/mint/actions/workflows/unit-tests.yaml) [![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) [![Chat on Discord](https://img.shields.io/badge/chat-Discord-7289DA?logo=discord)](https://discord.gg/MPNgtSZkgK) [![Discuss on GitHub](https://img.shields.io/badge/discussions-GitHub-333333?logo=github)](https://github.com/mintlify/mint/discussions)
3
+ DocsALot CLI wrapper package.
23
4
 
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.
5
+ ## Installation
46
6
 
7
+ ```bash
8
+ npm install --save-dev docsalot
47
9
  ```
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
10
 
53
- ### Custom Ports
11
+ ## Usage
54
12
 
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:
13
+ Run in a docs folder containing `layout.json`:
56
14
 
57
- ```
58
- mintlify dev --port 3333
15
+ ```bash
16
+ npx docsalot dev
59
17
  ```
60
18
 
61
- You will see an error like this if you try to run Mintlify in a port that's already taken:
19
+ Custom port:
62
20
 
21
+ ```bash
22
+ npx docsalot dev --port 3333
63
23
  ```
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
24
 
76
- ### 🏃 Get Started
25
+ ## Community
77
26
 
78
- [Create an account](https://mintlify.com/start) to start using Mintlify for your documentation.
27
+ Discord: https://discord.gg/Dp6EpTv4BU
package/package.json CHANGED
@@ -1,20 +1,12 @@
1
1
  {
2
2
  "name": "docsalot",
3
- "version": "0.1.0-beta.1",
3
+ "version": "0.1.0-beta.3",
4
4
  "description": "Alias for @docsalot/cli",
5
5
  "engines": {
6
6
  "node": ">=18.0.0"
7
7
  },
8
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
- },
9
+ "homepage": "https://docsalot.dev",
18
10
  "license": "Elastic-2.0",
19
11
  "keywords": [
20
12
  "docsalot",
@@ -31,7 +23,7 @@
31
23
  "docsalot": "index.js"
32
24
  },
33
25
  "dependencies": {
34
- "@docsalot/cli": "0.1.0-beta.1",
35
- "@docsalot/previewing": "0.1.0-beta.1"
26
+ "@docsalot/cli": "^0.1.0-beta.3",
27
+ "@docsalot/previewing": "^0.1.0-beta.3"
36
28
  }
37
29
  }