Git Product home page Git Product logo

woman's Introduction

Woman: Man pages that make you say "woah"

Version number meread templated MIT Licensed


Why

Reading man pages in your terminal is cluttered and ugly. The first man page was written in 1971, and they still look the same. With all of the modern UI trends sweeping the web world, we should not have to struggle with outdated manual pages for the very software we have built the web upon.


Where man fails, woman succeeds


Now you can open man pages in your browser using beautiful, modern css styling.


Installation

npm install -g woman

Windows Users

woman does not work by default in powershell, consider installing Cygwin and add it to your path.

See this prior issue for Windows info


Usage

View your man pages in a modern way. Ports local man pages directly into your browser with modern UI and font trends.

woman ls    #Open the man page for ls using woman
woman man   #Open the man page for man using woman

woman's People

Contributors

dawsbot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

woman's Issues

support readme files

Modern hackers don't make man pages, they make readme's. Support those. In the cases that man cannot find a man page, look for a readme in that command's home folder. If one exists, convert it to html and continue opening that like normal.

Support:

  • markdown
  • txt
  • Any other common readme formats?

No man entry handling

If there is not a man entry right now, woman still throws out a browser to some expty text. Do not open a browser in these situations.

html and css things

  • Link to the woman github repo on the woman page (perhaps in the footer)
  • Include a link to where they can read more about this module/man page
  • favicon

man is not working in cmd on Windows 10

When running woman on Windows 10 in Powershell or cmd I get this error:

PS C:\Users\oskar> woman ls
'man' is not recognized as an internal or external command,
operable program or batch file.

Error: Command failed: C:\WINDOWS\system32\cmd.exe /s /c "man ls | groff -mandoc -Thtml"
'man' is not recognized as an internal or external command,
operable program or batch file.

Looks like man is not working in cmd, is it possible to use Powershell instead?

/tmp handling

  • Make the /tmp directory only if it does not exist
  • Writes to a hidden file instead of a public?

change filename

Change the filename of the generated woman page from woman.html to <package_name>.html

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.