{"id":42926738,"url":"https://github.com/coderefinery/sphinx-minipres","last_synced_at":"2026-01-30T18:10:38.255Z","repository":{"id":57469986,"uuid":"201123569","full_name":"coderefinery/sphinx-minipres","owner":"coderefinery","description":"Lightweight presentations out of any webpage","archived":false,"fork":false,"pushed_at":"2020-10-29T10:36:53.000Z","size":25,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-10T04:44:27.339Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/coderefinery.png","metadata":{"files":{"readme":"README.rst","changelog":null,"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":"2019-08-07T20:31:49.000Z","updated_at":"2022-06-18T03:09:05.000Z","dependencies_parsed_at":"2022-09-19T10:11:01.079Z","dependency_job_id":null,"html_url":"https://github.com/coderefinery/sphinx-minipres","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/coderefinery/sphinx-minipres","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-minipres","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-minipres/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-minipres/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-minipres/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderefinery","download_url":"https://codeload.github.com/coderefinery/sphinx-minipres/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderefinery%2Fsphinx-minipres/sbom","scorecard":{"id":297517,"data":{"date":"2025-08-11","repo":{"name":"github.com/coderefinery/sphinx-minipres","commit":"f78c96a01d427621b9fc90f06ef62a85d9d5baf3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-minipres/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-minipres/release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/coderefinery/sphinx-minipres/release.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:43","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:44","Warn: pipCommand not pinned by hash: .github/workflows/release.yml:54","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned","Info:   0 out of   3 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 2 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T19:54:42.616Z","repository_id":57469986,"created_at":"2025-08-17T19:54:42.616Z","updated_at":"2025-08-17T19:54:42.616Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28917035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T16:37:38.804Z","status":"ssl_error","status_checked_at":"2026-01-30T16:37:37.878Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2026-01-30T18:10:38.143Z","updated_at":"2026-01-30T18:10:38.249Z","avatar_url":"https://github.com/coderefinery.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Lightweight presentations out of any web page\n=============================================\n\nYou want to give a presentation.  But you also want the material to be\navailable in a plain reading format.  In fact, you want to target the\n\"looks good when read\" rather than the presentation mode.  And you\nwant the minimum work.\n\nThis extension transforms any HTML page into an presentation by hiding\nunnecessary elements, increasing space between the sections, and\nadding a direct scroll (using left and right arrow keys) between\nsections.\n\nRight now it is distributed as a `Sphinx documentation generator\n\u003chttps://www.sphinx-doc.org/\u003e`__ extension since that's how the\nauthors use it, but ``minipres.js`` should be usable by others.\n\nExamples:\n\n* `minipres mode\n  \u003chttps://scicomp.aalto.fi/scicomp/zen-of-scicomp/?minipres\u003e`__, vs\n  `normal page \u003chttps://scicomp.aalto.fi/scicomp/zen-of-scicomp/\u003e`__,\n  vs `plain mode\n  \u003chttps://scicomp.aalto.fi/scicomp/zen-of-scicomp/?plain\u003e`__.  In\n  minipres mode, try pushing left and right arrow keys.\n\n\nSphinx extension usage\n----------------------\n\nInstall::\n\n  pip install sphinx-minipres\n\nAdd to extensions::\n\n  extensions = [\n    'sphinx_ext_minipres',\n  ]\n\nIn any rendered page:\n\n* Add ``?pres`` to the URL to go into slideshow mode\n* Add ``?plain`` to go into \"plain\" mode - no scrolling, but remove\n  unnecessary elements from the page (most useful for sphinx_rtd_theme)\n* Add ``\u0026h=3`` (or so on) to the URL to select the highest (or lowest\n  actually) heading to use as each section\n\nIn the slideshow mode, you can use the left and right arrow keys to\nnavigate.\n\n\n\nIndependent usage\n-----------------\n\nThe sphinx extension simply copies ``minipres.js`` to the build and\nincludes it - there is not much Sphinx specific here.\n\nOn an unrelated website with it hard coded, minipres can be loaded\ndynamically from the browser console ``x =\n$.getScript('/path/to/minipres.js')`` and then started with\n``minipres()``\n\n\n\nDevelopment status\n------------------\n\nAlpha and works.  However, it needs to be adapted to work for each\ntheme/page style, which will limit its usefulness.  Currently removes\nunneeded elements on ``sphinx_rtd_theme`` but the core scrolling\nprobably works on others.\n\n\n\nSee also\n--------\nPlease let me know if you know of other tools such as this.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fsphinx-minipres","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderefinery%2Fsphinx-minipres","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderefinery%2Fsphinx-minipres/lists"}