@opendocsdev/cli 0.2.0 → 0.2.1
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/README.md +7 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# opendocs
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/@opendocsdev/cli)
|
|
4
4
|
[](https://github.com/chigala/opendocs/blob/main/LICENSE)
|
|
5
5
|
|
|
6
6
|
Beautiful docs with zero config. An open-source alternative to [Mintlify](https://mintlify.com).
|
|
@@ -10,13 +10,13 @@ Write documentation in MDX, get built-in search, syntax highlighting, theming, a
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
npm install -g
|
|
13
|
+
npm install -g @opendocsdev/cli
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
Or use directly with npx:
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
npx
|
|
19
|
+
npx @opendocsdev/cli init my-docs
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
## Commands
|
|
@@ -191,15 +191,15 @@ Tabbed code blocks for showing the same example in multiple languages:
|
|
|
191
191
|
````mdx
|
|
192
192
|
<CodeGroup>
|
|
193
193
|
```bash npm
|
|
194
|
-
npm install
|
|
194
|
+
npm install @opendocsdev/cli
|
|
195
195
|
```
|
|
196
196
|
|
|
197
197
|
```bash pnpm
|
|
198
|
-
pnpm add
|
|
198
|
+
pnpm add @opendocsdev/cli
|
|
199
199
|
```
|
|
200
200
|
|
|
201
201
|
```bash yarn
|
|
202
|
-
yarn add
|
|
202
|
+
yarn add @opendocsdev/cli
|
|
203
203
|
```
|
|
204
204
|
</CodeGroup>
|
|
205
205
|
````
|
|
@@ -223,7 +223,7 @@ yarn add opendocs
|
|
|
223
223
|
<Steps>
|
|
224
224
|
### Install the CLI
|
|
225
225
|
|
|
226
|
-
Run `npm install -g
|
|
226
|
+
Run `npm install -g @opendocsdev/cli`.
|
|
227
227
|
|
|
228
228
|
### Create a project
|
|
229
229
|
|