{"id":15659621,"url":"https://github.com/magicdawn/razor-tmpl","last_synced_at":"2025-09-25T18:15:21.583Z","repository":{"id":16640700,"uuid":"19395959","full_name":"magicdawn/razor-tmpl","owner":"magicdawn","description":"razor style template engine for JavaScript","archived":false,"fork":false,"pushed_at":"2017-04-08T23:25:54.000Z","size":342,"stargazers_count":21,"open_issues_count":3,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-13T03:54:03.103Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/magicdawn.png","metadata":{"files":{"readme":"README.md","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":"2014-05-03T05:11:10.000Z","updated_at":"2021-09-07T06:24:22.000Z","dependencies_parsed_at":"2022-09-22T23:21:24.268Z","dependency_job_id":null,"html_url":"https://github.com/magicdawn/razor-tmpl","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicdawn%2Frazor-tmpl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicdawn%2Frazor-tmpl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicdawn%2Frazor-tmpl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/magicdawn%2Frazor-tmpl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/magicdawn","download_url":"https://codeload.github.com/magicdawn/razor-tmpl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251892483,"owners_count":21660976,"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":[],"created_at":"2024-10-03T13:17:51.673Z","updated_at":"2025-09-25T18:15:16.550Z","avatar_url":"https://github.com/magicdawn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# razor-tmpl\nrazor-style template engine for JavaScript. node.js \u0026 browser are supported.\n\n## Install\n- using with node.js or browserify\n\n    ```\n    $ npm i razor-tmpl --save\n    ```\n\t\n- using in browser with a script tag\n\t\n\t- refer from GitHub\n\n\t\t```html\n\t\t\u003cscript src=\"https://rawgit.com/magicdawn/razor-tmpl/master/browser/razor-tmpl.js\"\u003e\n\t\t\u003c/script\u003e\n\t\t```\n        \n\t- direct download\n\t\tdist file locates in `browser/` directory\n\t\t- `razor-tmpl.js`\n\t\t- `razor-tmpl.min.js`\n    \n*Note: legacy browsers need ES5 support,see [es5-shim](https://github.com/es-shims/es5-shim)*\n\n## Get Started\n```js\nvar razor = require('razor-tmpl');\nvar template = '@{ var name = \"zhangsan\"; } name is @name , age is @age .';\nvar locals = {\n    age: 18\n};\nconsole.log(razor.render(template,locals));// name is zhang, age is 18\n```\n\n- `age` is passed by `locals`, can be referenced as `@age` or `@locals.age`.\n- `locals` can be configed via `razor.localsName`, such as `razor.localsName = \"model\";` then use `@model.age`\n\n\n## Syntax\n\n- string interpolation\n\t```html\n    @locals.someProperty\n    @someProperty\n    @(locals.someProperty)\n    @(someProperty)\n    \n    @(- someProperty) // -  means escape\n    ```\n\t\n    *NOTE: `@someProperty` matched with `/^([\\w\\._\\[\\]])+/`*\n\n- control flow\n\t- if else\n\t\t```html\n        @if(true){\n        \tsome-template\n        }\n        \n        @if(false){\n        \tsome-template\n        } else {\n        \tother-template\n        }\n        \n        @if(false){\n        \tcase1-template\n        } else if(false){\n        \tcase2-template\n        } else {\n        \tcase3-template\n        }\n        ```\n\t- loop\n\t\t```html\n        @for(var i = 0,len=locals.someArray.length;i\u003clen;i++){\n        \t\u003cdiv\u003e@(locals.someArray[i])\u003c/div\u003e\n        }\n        \n        @* @each is same to @for loop *@\n        @each(item in locals.someArray){\n        \t\u003cdiv\u003e@item\u003c/div\u003e\n        }\n        \n        @while(locals.val \u003e 0){\n        \t@locals.val\n            @{\n            \tlocals.val--;\n            }\n        }\n        ```\n- code block\n    ```html\n    @{ \n        // here is some code\n        // as you see in @while(){ locals.val--; }\n    }\n    ```\n- comment\n\t```html\n    @{\n    \t// code-block is normal js\n        /* so whatever is OK */\n    }\n    \n    @* it's a razor comment and will not be in the output *@\n    \n    \u003c!-- html comment, output as it like --\u003e\n    ```\n\n### template inherit syntax for node.js\n\n- `@layout(\"layout.html\");` / `@renderBody();`\n    for specify layout / fill layout\n\n- `@renderSection('header');` / `@section`\n    for define a section / fill a section\n\n- `@include();` support\n\n## API\n### common( for node.js \u0026 browser)\n\n- razor.render(template,locals) =\u003e result\n- Engine\n\t```js\n    var razor = require('razor');\n    var Engine = razor.Engine; // razor engine class definition\n    \n    // And razor is the default export engine\n    razor instanceof Engine; // true\n    ```\n    \n    - engine#localsName : config `locals` used in template\n    - engine#symbol : config `@` used in template\n    - engine#easyLocals : default to `true`,means `@val` -\u003e `@locals.val`\n\n### browser side only\n*only if jQuery load before razor-tmpl as window.jQuery*\n- $.fn.render -\u003e use a dom element or a script tag's innerHTML as template\n\n### node side only\n- razor.renderFileSync(file,locals) =\u003e result\n- razor.enableCache = false | true\n\n*for node's template*\n```js\nrequire/__dirname/__filename\n```\nis also available,so you can use `razor` cli tool to render file without js code participate in.\n\n## TODOS\n\n- [x] fix help message in bin cli tool\n- [ ] add error message for template parsing\n- [ ] add debug mode for easy debug\n- [ ] add `path` option for node side, same as less import path\n- [ ] implement elegant template parser\n\n## Other\n\n- Sublime Text 3 Editor support,search `razor-tmpl` via Package Control\n- Original version was based on [kino.razor](https://github.com/kinogam/kino.razor)\n\n## Benchmark\nComparsion : http://cnodejs.org/topic/4f16442ccae1f4aa27001109\n\nResult : see [benchmark.js](https://github.com/magicdawn/razor-tmpl/blob/master/benchmark.js)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicdawn%2Frazor-tmpl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmagicdawn%2Frazor-tmpl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmagicdawn%2Frazor-tmpl/lists"}