Socket
Book a DemoInstallSign in
Socket

mdocify

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mdocify - npm Package Compare versions

Comparing version

to
0.1.0-0

.prettierrc.js

24

package.json
{
"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"
}
}

32

README.md

@@ -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

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.