Code Monkey home page Code Monkey logo

docs's Introduction

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 documention for Webix 2.4 - http://docs.webix.com/chm/webix_v24.chm

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.

docs's People

Contributors

dandv avatar mafanya23 avatar maria-staskova avatar mkozhukh avatar mstaskova avatar zwillinge avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.