Comparing version
{ | ||
"name": "mdocify", | ||
"version": "0.0.1-rc-1", | ||
"description": "command line tool to generate bolierplat md file of current working directory in the required folder", | ||
"version": "0.1.0-0", | ||
"description": "command line tool to generate bolierplate md files for the files or folders in the current working directory,wherever this cli runs", | ||
"main": "index.js", | ||
"author": "vinitraj10", | ||
"license": "MIT", | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/vinitraj10/mdocify.git" | ||
}, | ||
"bin": { | ||
"mdocify": "./cli.js" | ||
"mdocify": "./src/cli.js" | ||
}, | ||
@@ -16,3 +20,17 @@ "dependencies": { | ||
"touch": "^3.1.0" | ||
}, | ||
"keywords": [ | ||
"cli", | ||
"docusarus", | ||
"docusarusv2", | ||
"v2.docusarus.io", | ||
"facebook", | ||
"react", | ||
"react-native", | ||
"automated-doc-generator", | ||
"automated-cli" | ||
], | ||
"devDependencies": { | ||
"prettier": "^2.0.5" | ||
} | ||
} |
@@ -7,19 +7,31 @@ # Intro | ||
## Using yarn or npm | ||
Using package manager you would get the latest stable version of cli,But its not stable either ;) | ||
To automatically link `mdocify` to your environment variables you would need to add it as a global package,if you install to any particular project dependencies,you might need to link it by yourself by using some commands which has been described below | ||
```bash | ||
$ yarn global add mdocify | ||
# or | ||
$ npm install -g modcify | ||
``` | ||
## Using github | ||
Using github clone you would get the latest development code of cli,which you would need to manually link to your path by using `npm` or `yarn` `link` command | ||
### Step - 1 | ||
**Cloning the project since its not availabe on npm registry** | ||
```bash | ||
$ git clone https://github.com/vinitraj10/mdocify | ||
``` | ||
git clone https://github.com/vinitraj10/mdocify | ||
``` | ||
### Step - 2 | ||
**Installing all dependencies** | ||
```bash | ||
$ cd mdocify && yarn | ||
``` | ||
cd mdocify && yarn | ||
``` | ||
### Step-3 | ||
**Linking the cli to the terminal,this will add symlink or path to your environment variables** | ||
```bash | ||
$ yarn link | ||
``` | ||
yarn link | ||
``` | ||
### Step-4 | ||
@@ -50,5 +62,5 @@ **Edit your sidebars.js of docusarus-v2 for handling the updates in sidebar** | ||
So you need to run | ||
```bash | ||
$ <project>/components> mdocify | ||
``` | ||
<project>/components> mdocify | ||
``` | ||
on root directory like here its `components`,it will magically search for `documentation` directory which resides in your project root if you are using `docusarus-v2`. | ||
@@ -69,5 +81,5 @@ | ||
```bash | ||
$ yarn start | ||
``` | ||
yarn start | ||
``` | ||
@@ -74,0 +86,0 @@ # Disclaimer |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
9228
14.55%4
33.33%141
4.44%85
16.44%1
-50%1
Infinity%1
Infinity%