jsdef - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

		{
		"name": "jsdef",
		"version": "0.1.0",
		"version": "0.1.1",
		"description": "A tool to parse documentation for javascript in a more straight-forward way",
		@@ -5,0 +5,0 @@ "main": "index.js",

README.md

		@@ -17,13 +17,13 @@ # jsDef

		## Usage
		## Install

		### Install

		```console
		$ npm install -g jsdef
		```
		npm install -g jsdef

		```
		### Maintenance a config file
		## Usage

		```
		### Maintain a config file

		```console
		jsdef init-config
		@@ -34,3 +34,3 @@ ```

		```
		```js
		module.exports = {
		@@ -57,10 +57,10 @@ projectKey: 'myProject-1.0.0',

		```console
		$ jsdef parse
		```
		jsdef parse
		```
		### Generating dist files

		```console
		$ jsdef release
		```
		jsdef release
		```
		open the config.dist -> index.html to see the results
		@@ -70,10 +70,10 @@

		```console
		$ jsdef watch-server
		```
		jsdef watch-server
		```
		### Run a prod server

		```console
		$ jsdef prod-server
		```
		jsdef prod-server
		```

		@@ -86,11 +86,8 @@ ## Writing

		```
		could refer to #@api.lib.startParsing for the details...
		```js
		// could refer to #@api.lib.startParsing for the details...

		// resolve the [card-0526#@iteration-1-card-0526] issue...
		```
		```
		resolve the [card-0526#@iteration-1-card-0526] issue...

		```

		### Doc files writing
		@@ -100,3 +97,3 @@

		```
		```markdown
		# Iterations :iteration-top
		@@ -118,3 +115,3 @@ ... ...

		```
		```js
		// @start-def: Point: {}
		@@ -177,3 +174,3 @@ var Point = {

		```
		```js
		/**
		@@ -192,3 +189,3 @@ * @param {string} first
		}
		```
		```

		@@ -195,0 +192,0 @@ Any property is defined in the style of "full path". That's not easy to write and maintain. Imagine that you are refactoring the structure of teams, e.g. renaming "members"

New alerts