Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme fixes #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme fixes #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87d6d43
made node modules ignored.
PieterO Jun 19, 2017
978907f
readme typos and heading formatting.
PieterO Jun 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@
.idea/watcherTasks.xml

.idea/workspace.xml

# Exported modules
/node_modules/*
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#TSDoc#
# TSDoc #

A [JSDoc3](http://usejsdoc.org/) base themed generator generator for use with Typescript Projects, uses a highly modified version [Docstrap](https://github.com/terryweiss/docstrap/) JsDoc3 Template.

Actually it only supports parsing of plain comments, also it needs some added "manual" anotation. You can see an output [Example](http://xperiments.github.io/TSDoc/docs/index.html).
Actually it only supports parsing of plain comments, also it needs some added "manual" annotation. You can see an output [Example](http://xperiments.github.io/TSDoc/docs/index.html).

![image](http://xperiments.github.io/TSDoc/TSDocScreen.png)

Expand All @@ -19,7 +19,7 @@ Actually it only supports parsing of plain comments, also it needs some added "m
* Added Callbacks support
* Added Events support
* Added Tutorial support
* Enhaced search with autocomplete
* Enhanced search with autocomplete

### v0.0.1 ###

Expand All @@ -32,13 +32,13 @@ You can find annotated source files inside the output [example](http://xperiment



## Instalation ##
## Installation ##

sudo npm install tsdoc -g

## Preparing your project ##

###Configuration###
### Configuration ###

TSDoc uses the same [conf.json](http://usejsdoc.org/about-configuring-jsdoc.html) (now tsdoc.json) config file used in JsDoc3, but adds the following new options:

Expand All @@ -53,7 +53,7 @@ TSDoc uses the same [conf.json](http://usejsdoc.org/about-configuring-jsdoc.html
}


####Options####
#### Options ####

* __source__ Source folder where search .ts files
* __destination__ Documentation output folder
Expand All @@ -66,17 +66,17 @@ TSDoc uses the same [conf.json](http://usejsdoc.org/about-configuring-jsdoc.html

### Adding a default tsdoc.json file

You can automatically add a new tsdoc.json file to any folder in yor system, typing in your console:
You can automatically add a new tsdoc.json file to any folder in your system, typing in your console:

$> tsdoc -i

## Command line options ##

$> tsdoc -i [--install]
This will install the necesary tsdoc files to the current working directory.
This will install the necessary tsdoc files to the current working directory.

$> tsdoc
Generaties documentation from tsdoc.json settings.
Generates documentation from tsdoc.json settings.

## License ##

Expand Down