{"id":29575547,"url":"https://github.com/albertprinz/manochrome","last_synced_at":"2025-07-19T11:01:45.201Z","repository":{"id":280426605,"uuid":"941731731","full_name":"albertprinz/manochrome","owner":"albertprinz","description":"Create pretty web pages from POD files in a man page like style","archived":false,"fork":false,"pushed_at":"2025-03-03T10:36:39.000Z","size":308,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-05T00:04:24.753Z","etag":null,"topics":["man","perl","pod"],"latest_commit_sha":null,"homepage":"https://3cf173ba.github.io/manochrome/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/albertprinz.png","metadata":{"files":{"readme":"Readme.pod","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-03T00:23:20.000Z","updated_at":"2025-03-15T12:39:25.000Z","dependencies_parsed_at":null,"dependency_job_id":"208b316e-3b6c-4fb6-92da-fb462352903b","html_url":"https://github.com/albertprinz/manochrome","commit_stats":null,"previous_names":["3cf173ba/manochrome","albertprinz/manochrome"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/albertprinz/manochrome","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albertprinz%2Fmanochrome","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albertprinz%2Fmanochrome/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albertprinz%2Fmanochrome/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albertprinz%2Fmanochrome/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/albertprinz","download_url":"https://codeload.github.com/albertprinz/manochrome/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albertprinz%2Fmanochrome/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265921734,"owners_count":23849679,"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","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":["man","perl","pod"],"created_at":"2025-07-19T11:01:07.925Z","updated_at":"2025-07-19T11:01:45.189Z","avatar_url":"https://github.com/albertprinz.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"=pod\n\n=begin html\n\n\u003cimg src=\"img/screeny.png\"\u003e\n\n=end html\n\n=head1 NAME\n\nMANochrome\n- CSS and Javascript for HTML generated by L\u003cpod2html(1)\u003e.\n\nmanopod2html\n- Converts F\u003c.pod\u003e files to F\u003c.html\u003e files with MANochrome included.\n\n=head1 SYNOPSIS\n\nB\u003cmanopod2html\u003e B\u003c-t\u003e theme [B\u003c-i\u003e input_file] B\u003c-o\u003e output_file [B\u003c-f\u003e]\n\n=head1 DESCRIPTION\n\nThe goal is to present information in a man page like style with some\nappeal to the eye. The I\u003cdark\u003e theme comes closest to that goal.\nThe I\u003cmonk\u003e theme deviates a bit from the initially monochrome style while\nstill being simple and giving a pleasant reading experience. It's inspired\nby L\u003chttps://perlmonks.org\u003e.\n\nWhile the intention is mainly to convert F\u003c.pod\u003e files, it is also possible to\nconvert man pages. For further information, please see the L\u003c\"EXAMPLES\"\u003e\nsection.\n\nNicely formatted F\u003c.pod\u003e files work best and look great.\n\n=head2 MANochrome\n\nA set of cascading stylesheets (themes) and some Javascript which is\nexplained in the following sections.\n\n=head3 Themes\n\ncan be included in the \u003chead\u003e of an HTML file and will change the\nlook of the HTML page. \nThey can be used in any HTML file but are intended to be used with HTML\ngenerated by L\u003cpod2html(1)\u003e.\n\nAvailable themes are\n\n  light\n  dark\n  monk\n\n=head3 Javascript\n\nis optional but must be inserted before the closing C\u003cbody\u003e tag.\n\n=head3 class MANochrome\n\nThe parent class, it is not initialized.\n\n=head3 class MANochrome_pod\n\ncreates a sidebar with a fixed index where a link to the corresponding\nsection is B\u003chighlighted\u003e when B\u003cscrolling\u003e through the page or when\nB\u003cclicked\u003e.\nAn Index must be present in the HTML for this to work. L\u003cpod2html(1)\u003e\ngenerates an index by default. Said index is an unordered list (C\u003c\u003cul\u003e\u003e) with\nthe C\u003cid\u003e C\u003c\"index\"\u003e.\n\nThe class must be initialized with some\nJavascript after F\u003cjs/manochrome.js\u003e was included.\n\n  const manochrome = new MANochrome_pod();\n\n=head3 options\n\nWhen initializing with C\u003cnew MANochrome_pod()\u003e an I\u003coptions\u003e object\ncan can be passed. This must be adjusted manually but is very easy. \nTake a look at F\u003cjs/init.js\u003e, L\u003c\"manopod2html\"\u003e inserts the content of this\nfile inside a script tag below the closing body tag.\n\n=over 4\n\n=item B\u003clogo_path\u003e \u003cstring\u003e\n\nA path or URL to the image.\n\n=item B\u003clinks\u003e \u003carray\u003e\n\nAn array of objects like:\n\n    \"links\": [\n      {\n        \"url\": \"https://github.com/3cf173ba/manochrome.git\",\n        \"html\": \"\u003cimg src=\\\"img/github-mark-white.svg\\\"\"\u003e Repo\"\n      },\n      {\n        \"url\": \"https://perl.org\",\n        \"html\": \"perl.org\"\n      },\n      {\n        \"url\": \"https://perlmonks.org\",\n        \"html\": \"perlmonks.org\"\n      }\n    ]\n\n=back\n\nL\u003c\"manopod2html\"\u003e can do all of this for you.\n\n=head2 manopod2html\n\nThis perl script uses C\u003cPod::Html\u003e to generate HTML from a F\u003c.pod\u003e file.\nIf used without the B\u003c-f\u003e flag, it will create a directory\nF\u003cmanochrome_build\u003e with the structure\n\n=encoding UTF-8\n\n\tmanochrome_build\n\t+-- css\n\t|   \\-- manochrome_dark.css\n\t+-- index.html\n\t\\-- js\n\t    \\-- manochrome.js\n\nwhere \u003ctheme\u003e is the theme chosen with the B\u003c-t\u003e flag and\n\u003coutput.html\u003e is the output file name chosen with B\u003c-o\u003e.\n\n=head3 OPTIONS\n\n=over 4\n\n=item B\u003c-t\u003e \u003ctheme\u003e\n\nPass the name of a theme.\n\n=item B\u003c-i\u003e \u003cinput_file\u003e\n\nPass the input file.\n\nIf this flag is ommitted, read from STDIN.\n\n=item B\u003c-o\u003e \u003coutput_file\u003e\n\nPass the output file.\n\n=item B\u003c-f\u003e\n\nBuild a single file with css and javascript included.\n\n=back\n\n=head1 EXAMPLES\n\n=head2 Build from POD\n\nBuild C\u003cindex.html\u003e from C\u003cReadme.pod\u003e in the repository\nL\u003chttps://github.com/3cf173ba/manochrome.git\u003e\n\n  manopod2html -i Readme.pod -o index.html -t dark -f\n\n=head2 Build from MAN\n\nThe tool L\u003crman(1)\u003e can create F\u003c.pod\u003e files from man pages.\nWe use it in combination with manopod2html:\n\n  man man | rman -f POD | \\\n  manopod2html -o man.html -t dark -f\n\n=head2 manochrome options\n\nAdd this script to the bottom of your html before the closing body tag to\ninitialize C\u003cMANochrome_pod\u003e with options.\n\n  \u003cscript\u003e\n    () =\u003e {\n      'use strict';\n    \n      const options = {\n        /*\n         * Add a logo to top of the sidebar.\n         */\n        \"logo_path\": \"img/logo.png\",\n        /*\n         * Add links to the \"LINKS\" section at the bottom of the sidebar.\n         * The \"LINKS\" section will only be created if this option is passed.\n         */\n        \"links\": [\n          {\n            \"url\": \"https://github.com/3cf173ba/manochrome.git\",\n            \"html\": \"\u003cimg src=\\\"img/github-mark-white.svg\\\"\u003e Repo\"\n          },\n          {\n            \"url\": \"https://perl.org\",\n            \"html\": \"perl.org\"\n          },\n          {\n            \"url\": \"https://perlmonks.org\",\n            \"html\": \"perlmonks.org\"\n          }\n        ]\n      };\n    \n      const manochrome = (MANochrome.has_index_id()) ? \n        new MANochrome_pod(options) : false;\n    \n    })();\n  \u003c/script\u003e\n\n=head1 INSTALLATION\n\nJust type\n\n  make\n\nto install and\n\n  make uninstall\n\nto uninstall.\n\n=head1 FILES\n\n=over 4\n\n=item F\u003c/usr/local/bin/manopod2html\u003e\n\n=item F\u003c/usr/local/share/man/man1/manochrome.1\u003e\n\n=item F\u003c/usr/local/share/man/man1/manopod2html.1\u003e\n\n=item F\u003c/usr/local/share/manochrome/js/manochrome.js\u003e\n\n=item F\u003c/usr/local/share/manochrome/js/init.js\u003e\n\n=item F\u003c/usr/local/share/manochrome/css/manochrome_dark.css\u003e\n\n=item F\u003c/usr/local/share/manochrome/css/manochrome_light.css\u003e\n\n=item F\u003c/usr/local/share/manochrome/css/manochrome_monk.css\u003e\n\n=back\n\n=head1 SEE ALSO\n\nL\u003cman(1)\u003e,\nL\u003cpod2html(1)\u003e,\nL\u003crman(1)\u003e,\nL\u003cpod2man(1)\u003e,\nL\u003cgroff(1)\u003e\n\n=head1 AUTHORS\n\nL\u003cA. Mendes|mailto:tray.mendes@gmail.com\u003e\nL\u003chttps://github.com/3cf173ba\u003e\n\n=head1 COPYRIGHT\n\nS\u003cI\u003cCopyright © 2024 A. Mendes\u003e\u003e\n\nMANochrome is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\n=cut\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbertprinz%2Fmanochrome","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falbertprinz%2Fmanochrome","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbertprinz%2Fmanochrome/lists"}