Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: public API info #7

Open
qfox opened this issue Aug 14, 2015 · 0 comments
Open

Docs: public API info #7

qfox opened this issue Aug 14, 2015 · 0 comments

Comments

@qfox
Copy link
Member

qfox commented Aug 14, 2015

Something like

## How to use

### API

#### convert(html: string, opts: Object): BEMJSON

Options:
- preserveComments: boolean - preserves comments as strings
- preserveWrongClasses: boolean - preserves non-standard classes
- naming: Object - `bem-naming` options used to parse classes

#### stringify(html: string, opts: Object): string

All `convert` options plus:
- indent: string - String used to indent nested objects (4 spaces by default: `'    '`)

Atm there are just examples without any interfaces.
@tadatuta tadatuta changed the title Docs: some public API info? Docs: public API info Aug 14, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@qfox