docufy

Docufy generates a static HTML page from a project's README file.

Usage no npm install needed!

<script type="module">
  import docufy from 'https://cdn.skypack.dev/docufy';
</script>

README

Docufy

npm version npm Build Status

Docufy generates a static HTML documentation page from a project's README file.

Install

npm install docufy -g

Use

Run docufy in your project directory.

Contributing

  1. Fork it
  2. Run npm install
  3. Run Gulp gulp
  4. Create your feature branch (git checkout -b my-new-feature)
  5. Commit your changes (git commit -am "Add some feature")
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

License

MIT © Ryan Burgess