Skip to content

Commit 48a8d69

Browse files
committed
updated README
1 parent 25c2f5f commit 48a8d69

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

README.md

+48-3
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ It looks easy, but sometimes you want to create basic table. Actually, I hate ab
1212

1313
## Usage
1414

15+
16+
1517
* ##### Basic table
1618

19+
20+
1721
```
1822
[jtable]
1923
Year,Make,Model,Length
@@ -29,54 +33,82 @@ Year,Make,Model,Length
2933
| 1994 | Ford | E350 | 2.34 |
3034
| 2000 | Mercury | Cougar | 2.38 |
3135

36+
37+
38+
3239
* ##### More complicated
3340

41+
3442
```
3543
[jtable]
3644
Year,Make,Model,Description,Price
3745
1997,Ford,E350,ac,3000.00
3846
1999,Chevy,Venture Extended Edition,,4900.00
3947
1999,Chevy,Venture Extended Edition and Very Large,,5000.00
4048
1996,Jeep,Grand Cherokee,MUST SELL!,4799.00
41-
[/jtable]```
49+
[/jtable]
50+
```
51+
52+
53+
4254
| Year | Make | Model | Description | Price |
4355
|------|-------|---------------------------------------------|---------------|---------|
4456
| 1997 | Ford | E350 | ac | 3000.00 |
4557
| 1999 | Chevy | Venture Extended Edition | | 4900.00 |
4658
| 1999 | Chevy | Venture Extended Edition and Very Large | | 5000.00 |
4759
| 1996 | Jeep | Grand Cherokee | MUST SELL! | 4799.00 |
60+
61+
4862
* ##### Table with no heading
4963

64+
65+
5066
```
5167
[jtable th="0"]
5268
row1col1,row1col2,row1col3
5369
row2col1,row2col2,row2col3
5470
row3col1,row3col2,row3col3
5571
[/jtable]
5672
```
73+
74+
75+
5776
| | | |
5877
|----------|----------|----------|
5978
| row1col1 | row1col2 | row1col3 |
6079
| row2col1 | row2col2 | row2col3 |
6180
| row3col1 | row3col2 | row3col3 |
6281

82+
83+
84+
6385
* ##### Table with caption without heading
6486

87+
88+
6589
```
6690
[jtable caption="This is caption" th="0"]
6791
row1col1,row1col2,row1col3
6892
row2col1,row2col2,row2col3
6993
row3col1,row3col2,row3col3
7094
[/jtable]
7195
```
96+
97+
7298
||This is caption ||
7399
|----------|----------|----------|
74100
| row1col1 | row1col2 | row1col3 |
75101
| row2col1 | row2col2 | row2col3 |
76102
| row3col1 | row3col2 | row3col3 |
103+
104+
77105
or if you want heading and caption both , you can delete ```th="0"```
106+
107+
78108
* ##### Table with auto index and It'll start from 1
79109

110+
111+
80112
```
81113
[jtable ai="1"]
82114
head1,head2,head3
@@ -86,24 +118,37 @@ row3col1,row3col2,row3col3
86118
row4col1,row4col2,row4col3
87119
[/jtable]
88120
```
121+
122+
89123
| No. | head1 | head2 | head3 |
90124
|:----:|:-------:|:------:|:------:|
91125
| 1 | row1col1 | row1col2 | row1col3 |
92126
| 2 | row2col1 | row2col2 | row2col3 |
93127
| 3 | row3col1 | row3col2 | row3col3 |
94128
| 4 | row4col1 | row4col2 | row4col3 |
95129

130+
131+
132+
96133
### Version
97134
3.0.2
98135

136+
137+
99138
### Installation
100139

101140
Add the plugin path to your PLUGINS setting in the pelicanconf.py file.
102141

103-
```PLUGINS = [... ,
104-
'just_table' , ... ]```
142+
143+
144+
```PLUGINS = [... , 'just_table' , ... ]```
145+
146+
105147
### Todo's
148+
106149
- Read from CSV
107150

151+
152+
108153
### License
109154
GPL

0 commit comments

Comments
 (0)