{"id":16528912,"url":"https://github.com/ryanzim/onessg","last_synced_at":"2025-09-15T05:31:02.128Z","repository":{"id":57314675,"uuid":"64252869","full_name":"RyanZim/onessg","owner":"RyanZim","description":"The Static Site Generator that does only one thing: compile your html and markdown.","archived":false,"fork":false,"pushed_at":"2019-05-02T13:20:19.000Z","size":110,"stargazers_count":13,"open_issues_count":10,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-01T13:54:07.883Z","etag":null,"topics":["html","javascript","markdown","static-site-generator","template-engine"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RyanZim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-07-26T20:37:56.000Z","updated_at":"2023-08-06T06:27:19.000Z","dependencies_parsed_at":"2022-09-12T15:01:59.645Z","dependency_job_id":null,"html_url":"https://github.com/RyanZim/onessg","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/RyanZim/onessg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanZim%2Fonessg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanZim%2Fonessg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanZim%2Fonessg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanZim%2Fonessg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RyanZim","download_url":"https://codeload.github.com/RyanZim/onessg/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanZim%2Fonessg/sbom","scorecard":{"id":123541,"data":{"date":"2025-08-11","repo":{"name":"github.com/RyanZim/onessg","commit":"e40a824a24424ffce717b33438320a93a7811574"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"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":"Code-Review","score":0,"reason":"Found 0/3 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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"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":-1,"reason":"no workflows found","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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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 28 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-16T03:07:11.162Z","repository_id":57314675,"created_at":"2025-08-16T03:07:11.162Z","updated_at":"2025-08-16T03:07:11.162Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275208470,"owners_count":25424030,"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-15T02:00:09.272Z","response_time":75,"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":["html","javascript","markdown","static-site-generator","template-engine"],"created_at":"2024-10-11T17:42:13.098Z","updated_at":"2025-09-15T05:31:01.818Z","avatar_url":"https://github.com/RyanZim.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# onessg\n\n[![Travis](https://img.shields.io/travis/RyanZim/onessg.svg?maxAge=2592000)](https://travis-ci.org/RyanZim/onessg)\n[![Coveralls branch](https://img.shields.io/coveralls/RyanZim/onessg/master.svg)](https://coveralls.io/github/RyanZim/onessg)\n[![npm](https://img.shields.io/npm/v/onessg.svg?maxAge=2592000)](https://www.npmjs.com/package/onessg)\n[![npm](https://img.shields.io/npm/l/onessg.svg?maxAge=2592000)](https://github.com/RyanZim/onessg/blob/master/LICENSE)\n\nonessg (One Static Site Generator) is the Static Site Generator that does only one thing: compile your html and markdown. It won't minify your JS, concat your CSS, or optimize your images. Why? You most likely already have a favorite tool for doing that.\n\n\u003e The Javascript pendulum has swung from restrictive, monolithic frameworks to modular, boilerplate-hindered libraries.\n\u003e\n\u003e-- [@ericclemmons](https://medium.com/@ericclemmons/javascript-fatigue-48d4011b6fc4#.7xcwmnave)\n\nonessg changes that. We believe in the unix philosophy: do one thing and do it well.\n\nWe also believe in setting useful, but overridable defaults. Because of this, onessg requires no configuration files to get started.\n\n## Contents\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [Installation](#installation)\n- [Example](#example)\n- [CLI Usage \u0026 Options](#cli-usage--options)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Installation\n\n```bash\nnpm install -D onessg\n```\n\nYou will also need to install the jstransformer for your favorite template engine. For example, if you use [EJS](https://github.com/mde/ejs), you would run:\n\n```bash\nnpm install -D jstransformer-ejs\n```\n\nYou can read more about jstransformers [here](docs/jstransformer.md).\n\n**Note:** We recommend installing onessg as a devDependency (with the `-D` flag) and running it via an npm script. If you choose to install onessg globally, you will also need to install the jstransformer globally as well.\n\n## Example\n\nAssuming the following file/directory structure:\n```\n.\n├── src/\n|   ├── _defaults.yaml\n|   └── page-one.md\n├── layouts/\n|   └── page.ejs\n├── dist/\n└── package.json\n```\n\n**src/page-one.md**:\n```html\n---\ntitle: \"My first Page\"\n_layout: \"page\"\n---\nHello World!\n```\n\nThe front-matter (the part between the `---` lines) is written in YAML ([other languages](https://github.com/jonschlinkert/gray-matter#optionslang) are supported as well). All keys in the front-matter will be passed as locals to your templates.\n\nNotice the underscore before `layout`. _Anything prefixed with an underscore is reserved word for onessg._ See the [full list of underscore keys](docs/underscore-reference.md).\n\n---\n\nYou can set defaults for your front-matter in `_defaults.yaml` (`_defaults.json` works too!). These defaults can be overridden in your front-matter.\n\n**src/_defaults.yaml**:\n```yaml\ntitle: \"Hello World!\" # This title will be used if none is specified\nauthor: \"John Smith\"\n```\n\nIf you place a `_defaults.yaml` file in a subdirectory in `src/`, settings there will only apply to files in that subdirectory and its child subdirectories.\n\n---\n\nLayouts are written in the templating language of your choice. We are using EJS here, but you can use any template engine that has a [jstransformer](docs/jstransformer.md). You can also use multiple template engines in the same project! onessg will infer the correct template engine from the file extension.\n\n**layouts/page.ejs** looks like this:\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003cmeta charset=\"utf-8\"\u003e\n    \u003ctitle\u003e\u003c%= title %\u003e\u003c/title\u003e\n    \u003cmeta name=\"author\" content=\"\u003c%= author %\u003e\"\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003c%- _body -%\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\nNotice the local `_body`. This is the local for outputing the contents of each file. For **page-one.md**, it is `Hello World!`.\n\n---\n\n**Run:**\n\n```bash\nonessg\n```\n\nonessg will compile all the html and markdown files in `src/` (and subdirectories), and output them to `dist/` (retaining the directory structure):\n\n```\n.\n├── src/\n|   ├── _defaults.yaml\n|   └── page-one.md\n├── layouts/\n|   └── page.ejs\n├── dist/\n|   └── page-one.html\n└── package.json\n```\n\n**dist/page-one.html** looks like this:\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003cmeta charset=\"utf-8\"\u003e\n    \u003ctitle\u003eMy first Page\u003c/title\u003e\n    \u003cmeta name=\"author\" content=\"John Smith\"\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003cp\u003eHello World!\u003c/p\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n**Success!!!** :tada:\n\nA few notes:\n\n- The title (`My first Page`) comes from the front-matter.\n- The author's name (`John Smith`) comes from the `_defaults.yaml` file.\n\nFor further reading, see the [Tutorial](docs/tutorial.md).\n\n## CLI Usage \u0026 Options\n\n```\nonessg\nonessg [-s \u003csource_dir\u003e] [-d \u003coutput_dir\u003e] [-l \u003clayout_dir\u003e]\n\nOptions:\n--help         Show help                                             [boolean]\n--version      Show version number                                   [boolean]\n-s, --src      Set the src directory                [string] [default: \"src/\"]\n-d, --dist     Set the dist directory              [string] [default: \"dist/\"]\n-l, --layouts  Set the layouts directory        [string] [default: \"layouts/\"]\n-c, --config   Set the directory that contains onessg.config.js       [string]\n\nExamples:\n  onessg\n  onessg -s posts/ -d output/ -l templates/\n\n```\n\n## `onessg.config.js`\n\nTo pass options to your template engine, you will need to use a config file. Read more about it [here](docs/config.md).\n\n## Contributing\n\nContributions welcome; please read the [Contributing Guidelines](CONTRIBUTING.md) for more info.\n\nCheck the [Roadmap](https://github.com/RyanZim/onessg/wiki/Roadmap) to see what's on the horizon.\n\n## License\n\n[MIT](https://github.com/RyanZim/onessg/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanzim%2Fonessg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanzim%2Fonessg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanzim%2Fonessg/lists"}