search

wenzhixin / bootstrap-table-examples

Bootstrap table examples
https://examples.bootstrap-table.com/
MIT License
2.23k stars 1.62k forks source link

Documentation #214

Open xoorath opened 7 years ago

xoorath commented 7 years ago

Hey,

Some documentation instead of just examples would be very helpful.

As a start, a low hanging fruit might be to add the table source code under the tables in the examples, with relevant includes in a head tag.

Example.html

<head>
    <!-- example table dependencies -->
</head>
<body>
    <!-- example table -->
</body>

Example.json

[ {}, {} ] and so on

What would be even better would be a doc describing the parameters you can provide to the table tag, a list of all features, and a document for each extension.

GTANAdam commented 5 years ago

Agreed, this type of examples is one of the worst documentation I've ever seen. Sure, it's fancy but it provides no examples whatsoever, I'd rather see text on a blank page explaining stuff rather than see it working without explanations.

A good example of a simple and well structured documentation can be seen here: https://nakupanda.github.io/bootstrap3-dialog/

wenzhixin commented 1 year ago

@fish-fly can you help to improve this?