colldoc

1.0.3 • Public • Published

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

image

Todo

  • [X] Make a copy of your files with navigation.
  • [X] Choosing own names of folders.
  • [X] Log messages to consol.
  • [X] Pormpt for asking questions.
  • [ ] Sorting first on numbers then on letters.
  • [ ] Adding file name in file as a html title.

Package Sidebar

Install

npm i colldoc

Weekly Downloads

3

Version

1.0.3

License

MIT

Unpacked Size

24.1 kB

Total Files

13

Last publish

Collaborators

  • ivankaduk