{"id":13528243,"url":"https://github.com/tj/mad","last_synced_at":"2025-09-02T06:33:16.602Z","repository":{"id":3008293,"uuid":"4027235","full_name":"tj/mad","owner":"tj","description":"mad(1) is a markdown manual page viewer","archived":false,"fork":false,"pushed_at":"2017-09-18T10:28:50.000Z","size":42,"stargazers_count":248,"open_issues_count":9,"forks_count":24,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-09-02T06:32:43.185Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tj.png","metadata":{"files":{"readme":"Readme.md","changelog":"History.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-04-14T19:43:14.000Z","updated_at":"2025-05-13T11:52:48.000Z","dependencies_parsed_at":"2022-08-31T20:50:35.012Z","dependency_job_id":null,"html_url":"https://github.com/tj/mad","commit_stats":null,"previous_names":["visionmedia/mad"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/tj/mad","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tj%2Fmad","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tj%2Fmad/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tj%2Fmad/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tj%2Fmad/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tj","download_url":"https://codeload.github.com/tj/mad/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tj%2Fmad/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273244306,"owners_count":25070958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-02T02:00:09.530Z","response_time":77,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T06:02:20.993Z","updated_at":"2025-09-02T06:33:16.557Z","avatar_url":"https://github.com/tj.png","language":"Shell","funding_links":[],"categories":["Shell","Stale"],"sub_categories":["CLI \u0026 Terminal"],"readme":"\n# mad(1)\n\n  `mad(1)` is a markdown driven manual page viewer,\n  this makes manuals easier to _write_, _reuse_, and\n  _read_.\n  \n  For a newer / actively maintained thing check out [tldr](https://github.com/tldr-pages/tldr).\n\n  ![markdown man page](http://f.cl.ly/items/2G271F3c0D3p2i2V3l3k/Screen%20Shot%202012-04-14%20at%2012.44.58%20PM.png)\n\n## Usage\n\n    Usage: mad \u003cfile\u003e\n\n    Options:\n\n      -U, --update-self update mad(1) itself\n      -u, --update      update remote mad-pages\n      -v, --version     output cpm version\n      -h, --help        output this help information\n      -l, --list      list mad-pages\n\n## Installation\n\n  Install `mad(1)` and its associated mad page.\n\n    $ make install\n\n  Uninstall both `mad(1)` and the associated mad page.\n\n    $ make uninstall\n\n  Via npm:\n\n    $ npm install -g mad\n\n## About\n\n  I _love_ man pages, however they are annoying to write by hand,\n  and often converted from markdown anyway. `mad(1)` is effectively\n  the same idea, but write your manuals in markdown like you would anyway,\n  re-use them in your github readmes, wikis, or use markdown to HTML conversion\n  tools.\n\n  `mad(1)` pipes to `less(1)` so you get the same paging / searching\n  goodness that you expect from `man(1)`.\n\n## Page repository\n\n  [mad-pages](https://github.com/visionmedia/mad-pages) is a collection of\n  useful mad pages such as language operator precedence tables, http status\n  codes, mime type tables etc. Use `mad --update` to install/re-install them.\n\n## Page lookup\n\n  Use the __MAD_PATH__ environment variable to control\n  where `mad(1)` will look for a manual page.\n  The \".md\" extension may be omitted.\n\n  For example:\n  \n    MAD_PATH=\"/usr/share/mad:share/mad\"\n\n  The following paths will always be searched:\n  \n     - .\n     - /usr/local/share/mad\n     - /usr/share/mad\n\n## Configuration\n\n  By default `mad(1)` installs and sources `/usr/local/etc/mad.conf` for its formatting. You may edit this file directly, or if you're scared of overwriting it\n  when updating `mad(1)` you can copy this file to something like `~/mad.conf` and `export MAD_CONFIG=~/mad.conf`.\n\n```\nheading: 1m\ncode: 90m\nstrong: 1m\nem: 4m\n```\n\n## Screenshots\n\n  Jade manual:\n  \n  ![jade manual markdown](http://f.cl.ly/items/3g1v2W213S2N390B201q/Screen%20Shot%202012-04-14%20at%201.54.35%20PM.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftj%2Fmad","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftj%2Fmad","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftj%2Fmad/lists"}