Skip to content

lcguida/docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Webix UI Docs

Those are sources of http://docs.webix.com

  • all text pages are in the "data" folder
  • all images are in the "media" folder

Offline version

CHM version of Webix documention - http://docs.webix.com/chm/webix.zip

Differences from MarkDown

  • Tabs or 4+ spaces are used to separate two-column lists

    - line	cells with border (default)
    - clean	cells without border
    - wide	cells with border and small space between siblings
    - space	cells with border and wide space between siblings
    - head	similar to "wide", but there is any border between the first and second cells
    

    =>

    Screenshot

  • triple-tilde, ~~~ is used instead of ``` for code sections

    ~~~js
    webix.ui({
        view: "list",
        template: "#title#"
    }); // this list will show 'titles'
    ~~~

Autogenerated API files

It is useless to edit "ref" and "toc" pages (files containing "refs" or "toc" in the path).

Per-component reference pages are autogenerated from @short sections of child API articles, so it is enough to edit the @short section of the related article.

Summarizing tables of contents for UI components and mixins, or "toc" pages,
are autogenerated from {{memo }} sections of the related articles in the "obj" folder.

These memos are also included into component/mixin summarising pages (like DataLoader or Accordion) as a first line.

Both {{memo }} and @short sections are laconic descriptions of the functionality and, if possible, should be shortened to one line of text.

About

Documentation for Webix UI ( sources of http://docs.webix.com )

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 70.1%
  • PHP 13.3%
  • CSS 11.4%
  • HTML 4.5%
  • Other 0.7%