Mr. Doc é uma refatoração de <a target="_blank" href="https://github.com/punkave/dox-foundation/">dox-foundation</a> escrito em ES6, transformado para ES5 com Babel e é baseado no dox. Pode automaticamente gerar documentação elegante para código fonte com temas.
Por padrão, Mr. Doc usa o tema mr-doc-theme-default, baseado em <a target="_blank" href="https://twitter.github.com/bootstrap/">Bootstrap</a> e <a target="_blank" href="http://prismjs.com/">Prism.js</a> para syntax highlighting.
Instalação:
<pre><code>npm install -g mr-doc
</code></pre>Para ver se está funcionando, use o comando:
<pre><code>mr-doc --help
</code></pre>Imagine o seguinte exemplo de código JavaScript:
<pre><code>/**
* Imprime uma mensagem no console.
*/
function hello(name){
 console.log("hello, world!");
}
</code></pre>Essa função está no arquivo js/hello.js. A documentação deve seguir o mesmo padrão do <a target="_blank" href="http://pt.wikipedia.org/wiki/Javadoc">JavaDoc</a> . Um <a href="http://README.md" class="autolinkedURL autolinkedURL-url" target="_blank">README.md</a> na pasta raiz do projeto é usado como página inicial da documentação. O arquivo usa o formato <a target="_blank" href="http://pt.wikipedia.org/wiki/Markdown">Markdown</a> usado no Git. Agora você usa o seguinte comando na sua pasta raiz do projeto para gerar a documentação.
<pre><code>mr-doc -s js/ -o docs/ -n "Meu Projeto"
</code></pre>A documentação do seu código estará na pasta docs. Para mais informações sobre como criar novos temas e usar outras opções do Mr. Doc, procure a <a target="_blank" href="http://mr-doc.github.io/">documentação oficial</a> .
Até a próxima.

Mr. Doc é uma refatoração de  [dox-foundation](https://github.com/punkave/dox-foundation/)  escrito em ES6, transformado para ES5 com Babel e é baseado no dox. Pode automaticamente gerar documentação elegante para código fonte com temas.

Por padrão, Mr. Doc usa o tema mr-doc-theme-default, baseado em  [Bootstrap](https://twitter.github.com/bootstrap/)  e  [Prism.js](http://prismjs.com/)  para syntax highlighting.

Instalação:

```
npm install -g mr-doc
``` 

Para ver se está funcionando, use o comando:


```
mr-doc --help
``` 

Imagine o seguinte exemplo de código JavaScript:

```
/**
* Imprime uma mensagem no console.
*/
function hello(name){
    console.log("hello, world!");
}
``` 

Essa função está no arquivo **js/hello.js**. A documentação deve seguir o mesmo padrão do  [JavaDoc](http://pt.wikipedia.org/wiki/Javadoc) . Um **README.md** na pasta raiz do projeto é usado como página inicial da documentação. O arquivo usa o formato  [Markdown](http://pt.wikipedia.org/wiki/Markdown)  usado no Git. Agora você usa o seguinte comando na sua pasta raiz do projeto para gerar a documentação.


```
mr-doc -s js/ -o docs/ -n "Meu Projeto"
``` 


A documentação do seu código estará na pasta docs. Para mais informações sobre como criar novos temas e usar outras opções do Mr. Doc, procure a  [documentação oficial](http://mr-doc.github.io/) .

Até a próxima.

Conheça o Mr. Doc

O blog é mantido por Romualdo Costa, nascido em Feira de Santana (BA) e bacharel em Engenharia de Computação.
