What is a docmap?

A docmap is nothing more that a json file that lists all of the documentation you can have inside your project.

When we say "documentation", it means meanly "docblocks" that you may have written in your source files.

What is a docblock?

A docblock is a simple block written using the Docblock syntax.

It may look like this:

What a docmap.json file looks like?

A docmap.json file will look like something like this:

You can see that we have a lot of informations about our documentation.

What is the purpose of a docmap

A docmap can be useful for many things like indexing where to find the documentation for a particular function, class, etc...

It can be used to generate a documentation website as we are doing for the whole Coffeekraken ecosystem.

The only thing that limit what you can do with that is your imagination. As the docmap is just a "directory" of your documentation, you can build everything you want on top of that.

Make sure to take a look at the others documentation about docmap to learn how to build your own, how to write your docblocks for the best results as well as how to access your docmap through his simple API...

How to generate a docmap.json file

To build a docmap.json file, you can use either our @coffeekraken/s-docmap package, or through our CLI like so:

This will search for files in your src folder as well as in your generated dist/css/index.css file for docblock that have a @namespace tag AND a @name one. All docblocks finded will be part of your docmap.json file.

The build process will also reference all the dependencies packages that have a docmap.json file at their root folder. This in order to list also your dependencies documentation.

Note that you must have the @coffeekraken/cli package installed.