2017 © Pedro Peláez
 

library run-the-docs

Keep code and documentation in sync. Run code examples in a browser

image

widmogrod/run-the-docs

Keep code and documentation in sync. Run code examples in a browser

  • Thursday, December 28, 2017
  • by widmogrod
  • Repository
  • 1 Watchers
  • 0 Stars
  • 7 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 1 Open issues
  • 3 Versions
  • 0 % Grown

The README.md

run-the-docs

Introduction

Keep code and documentation in sync. Run code examples in a browser., (*1)

Specificaton (Draft), (*2)

Core concepts

  • [ ] Language agnostic. Generates documentation from any programming language.
  • [ ] Code is documentation. Keeping documentation inlined in code makes it's easier to be in sync with actual state of the codebase.
  • [ ] Examples are tests. Having examples as a test protects them from being outdate and therefore documentation from becoming obsolete.

The Versions

28/12 2017

dev-master

9999999-dev

Keep code and documentation in sync. Run code examples in a browser

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar widmogrod

28/12 2017

dev-feature/clean-up

dev-feature/clean-up

Keep code and documentation in sync. Run code examples in a browser

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar widmogrod

09/01 2017

dev-feature/next-wip

dev-feature/next-wip

Keep code and documentation in sync. Run code examples in a browser

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar widmogrod