https://github.com/doochik/borschik-doc
https://github.com/doochik/borschik-doc
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/doochik/borschik-doc
- Owner: doochik
- Created: 2013-07-26T12:36:47.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-07-26T12:46:28.000Z (almost 13 years ago)
- Last Synced: 2025-06-05T04:44:53.512Z (about 1 year ago)
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Borschik
[](http://travis-ci.org/bem/borschik)
[](http://badge.fury.io/js/borschik)
Borschik is an extendable builder for text-based file formats.
It's main purpose is the assembly of static files for web projects (CSS, JS, etc.).
You can get more info in [article at bem.info](http://bem.info/articles/borschik)
Also docs are [available in russian](README.ru.md).
## Examples
### Include files
`page.js`
```js
var myProjectNamespace = {};
/* borschik:include:js/module1.js */
```
`js/module1.js`
```js
myProjectNamespace.module1 = {}
```
The result file will be
```js
var myProjectNamespace = {};
myProjectNamespace.module1 = {}
```
### Links process
Borschik can change urls from relative to relative or absolute
```css
.a {
background: url("i/bg.png")
}
```
Can be processed to
```css
.a {
background: url("//yandex.ru/project/1.0.0/i/bg.png")
}
```
Or event process path as file hash sum
```css
.a {
background: url("//yandex.ru/project/_freezes/wFPs-e1B3wMRud8TzGw7YHjS08I.png")
}
```
## Install
Prerequisites:
* nodejs >= 0.6.x — [http://nodejs.org](http://nodejs.org)
* npm — [http://github.com/isaacs/npm/](http://github.com/isaacs/npm/)
From NPM for use as a command line app:
npm install borschik -g
From Git:
git clone git://github.com/bem/borschik.git
## Usage
```
borschik [OPTIONS] [ARGS]
```
The available options are:
-h, --help Help
-v, --version Current version
-t TECH, --tech=TECH Path to technology (default: file extenstion)
[string]
-i INPUT, --input=INPUT Input file (required)
[string]
-o OUTPUT, --output=OUTPUT Output file (required)
[string]
-f FREEZE, --freeze=FREEZE Freeze links to static files (default: yes)
[boolean]
-m MINIMIZE, --minimize=MINIMIZE Minimize resulting content (default: yes)
[boolean]
-c COMMENTS, --comments=COMMENTS Wrap included files with comments (default: yes)
[boolean]
## Technologies support
