Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
bringing documents alive
CoffeeScript
tree: 6f36481fb1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
docs
src
.gitignore
.npmignore
README.md
build.bat
package.json
test.bat

README.md

____________  ___   _   _  _   __ _____ _   _______ _____ _____ 
|  ___| ___ \/ _ \ | \ | || | / /|  ___| \ | |  _  \  _  /  __ \
| |_  | |_/ / /_\ \|  \| || |/ / | |__ |  \| | | | | | | | /  \/
|  _| |    /|  _  || . ` ||    \ |  __|| . ` | | | | | | | |    
| |   | |\ \| | | || |\  || |\  \| |___| |\  | |/ /\ \_/ / \__/\
\_|   \_| \_\_| |_/\_| \_/\_| \_/\____/\_| \_/___/  \___/ \____/
                                        bringing documents alive

Frankendoc allows making your documents executable.
Just point it to a folder and it will pick the docs along with the glue code.

Install

npm install -g frankendoc

Run

frank [folder]/[extension]

frank
  picks *.txt in current folder

frank *.doc
  picks *.doc in current folder

frank docs/*.md
  picks *.md in docs

Documentation

General

  • [[Settings]]
  • [[Docs Sources]]
  • [[Fail]]

Features

  • [[Steps]]
  • [[Args]]
  • [[Async]]
  • [[Regex]]

Plugins

  • [[Github]]
  • [[Confluence]]

Advanced

  • [[Reusing Steps]]
Something went wrong with that request. Please try again.