https://github.com/aidantwoods/markdownphpdocs

Markdown Documentation Generator for PHP
https://github.com/aidantwoods/markdownphpdocs

Last synced: about 1 month ago
JSON representation

Markdown Documentation Generator for PHP

• Host: GitHub
• URL: https://github.com/aidantwoods/markdownphpdocs
• Owner: aidantwoods
• License: mit
• Created: 2017-06-23T16:20:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-23T16:25:18.000Z (over 7 years ago)
• Last Synced: 2024-05-21T03:10:18.450Z (6 months ago)
• Language: PHP
• Size: 39.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MarkdownPhpDocs

Very hastily thrown together package to generate `*.md` files from a slightly

customised version of phpdoc.

## How to use

[![Tutorial](https://img.youtube.com/vi/I8dMcq259h8/0.jpg)](https://www.youtube.com/watch?v=I8dMcq259h8)

## Installation:

```bash

git clone https://github.com/aidantwoods/MarkdownPhpDocs

cd MarkdownPhpDocs

composer update

```

You can then either directly run the file `markdown-phpdoc` located in the

`bin` directory, or add this bin directory to your `~/.bash_profile` to run

from anywhere. e.g. by adding the lines:

```bash

PATH="[local-file-path-goes-here]/MarkdownPhpDocs/bin:${PATH}"

export PATH

```

> Note that you'll need composer to pull down the the customised version of

> phpdoc as a dependency

> ([available here](https://github.com/aidantwoods/phpDocumentor2/tree/no-markdown)),

> which serves to disable markdown processing in phpdoc (this to avoid markdown

> ending up within HTML, and thus not being ignored by most markdown parsers).

## Usage

```

markdown-phpdoc -f [input file] -t [target directory]

```