2017 © Pedro Peláez
 

project docmd

Generate documentation as markdown files

image

rzajac/docmd

Generate documentation as markdown files

  • Monday, February 5, 2018
  • by rzajac
  • Repository
  • 1 Watchers
  • 0 Stars
  • 9 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 10 Versions
  • 0 % Grown

The README.md

DocMd

Tool generating linked github.com flavored markdown documentation for PHP source., (*1)

Installation

Composer install:, (*2)

{
    "require": {
        "rzajac/docmd": "0.1.*"
    }
}

Composer globally:, (*3)

$ composer global require rzajac/docmd

How to use

$ docmd generate -h
Usage:
  generate [options]

Options:
  -c, --config[=CONFIG]  The path to docmd.json. If not set it will search for docmd.json in current directory
  -h, --help             Display this help message
  -q, --quiet            Do not output any message
  -V, --version          Display this application version
      --ansi             Force ANSI output
      --no-ansi          Disable ANSI output
  -n, --no-interaction   Do not ask any interactive question
  -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Help:
 Generate markdown documentation

Config file

The config is in JSON format., (*4)

{
  "tmp": "path/to/tmp/directory",
  "doc": "path/where/to/put/documentation",
  "src": "path/to/source/you/wish/to/generate/documentation/for",
  "project_name": "Name of your project"
}

All paths in this file must be relative to docmd.json file., (*5)

Examples

The Versions

05/02 2018

dev-master

9999999-dev

Generate documentation as markdown files

  Sources   Download

Apache-2.0 Apache License 2.0

The Requires

 

by Rafal Zajac

05/02 2018

0.1.8

0.1.8.0

Generate documentation as markdown files

  Sources   Download

Apache-2.0

The Requires

 

by Rafal Zajac

18/08 2016

0.1.7

0.1.7.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

by Rafal Zajac

18/08 2016

0.1.6

0.1.6.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

by Rafal Zajac

30/07 2016

0.1.5

0.1.5.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

by Rafal Zajac

29/11 2015

0.1.4

0.1.4.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

by Rafal Zajac

29/11 2015

0.1.3

0.1.3.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

by Rafal Zajac

29/11 2015

0.1.2

0.1.2.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

by Rafal Zajac

29/11 2015

0.1.1

0.1.1.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

The Development Requires

by Rafal Zajac

29/11 2015

0.1.0

0.1.0.0

Generate documentation as markdown files

  Sources   Download

Apache License 2.0

The Requires

 

The Development Requires

by Rafal Zajac