1.0.3 • Published 6 years ago
colldoc v1.0.3
Colldoc
Colldoc is a Cli tool that helps you build documentaion. To say more clear it simply make a copy of your HTML files in another directory and add in it navigation with local urls to each file.
Instalation
npm install -g colldoc
How to use
- Create documentation folder with "_doc" name or some another.
- Add in it html files with documentation information.
- Open bash or cmd and type
colldoc path/to/parent/directory
. - If you want to use custom names for your documentation folder then type:
colldoc path/to/parent/directory resourceDirectory resultDirectory
.
Preview
Todo
- Make a copy of your files with navigation.
- Choosing own names of folders.
- Log messages to consol.
- Pormpt for asking questions.
- Sorting first on numbers then on letters.
- Adding file name in file as a html title.