diff options
| author | Zsolt Kozaroczy <[email protected]> | 2020-09-11 00:36:29 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2020-09-11 00:36:29 +0200 |
| commit | 282eec44ef01746ee25931fa6cd287ad083fd40b (patch) | |
| tree | 14504bf429ca264812679ca971c1592853d3f762 /examples/README.md | |
| parent | 317e8244e4d17c394c1e181f86df3974623fb865 (diff) | |
| download | caxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.tar.gz caxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.zip | |
Restructure examples folder (#47)
Split examples into separate markdown files, each containing a description, sample code, and a screenshot of the resulting xlsx document.
The script `generate.rb` is provided to actually generate the example documents by executing the sample code contained in the markdown files.
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000..5b1abdc2 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,116 @@ +## Examples + +Usage: +* change dir to `examples` +* `ruby generate.rb` to run all examples +* `ruby generate.rb file1.md file2.md` to run specific examples +* `./generate.rb` is also supported + +### Basic + +* [Basic](basic_example.md) +* [Custom Styles](custom_styles_example.md) +* [Style Overrides](style_overrides_example.md) +* [Asian Language Support](asian_language_support_example.md) +* [Shared strings](shared_strings_example.md) +* [Serialize to stream](stream_example.md) +* [Complex example](complex_example.md) + +### Borders + +* [Custom Borders](borders_example.md) +* [Surrounding Borders](surrounding_borders_example.md) + +### Cells + +* [Merge Cells](merge_cells_example.md) +* [Automatic data types](automatic_data_types_example.md) +* [Override data types](override_data_types_example.md) + +### Conditional formatting + +* [Greater than](conditional_formatting_greater_than_example.md) +* [Between](conditional_formatting_greater_than_example.md) +* [Color scale](conditional_formatting_color_scale_example.md) +* [Data bar](conditional_formatting_data_bar_example.md) +* [Icon set](conditional_formatting_icon_set_example.md) + +### Charts + +Types: +* [Bar chart](bar_chart_example.md) +* [Line chart](line_chart_example.md) +* [Line chart (3D)](3d_line_chart_example.md) +* [Pie chart (3D)](3d_pie_chart_example.md) +* [Scatter chart](scatter_chart_example.md) + +Customizations: +* [Chart colors](chart_colors_example.md) +* [Hide gridlines](hide_gridlines_in_chart_example.md) + +### Columns + +* [Custom Column Styles](column_styles_example.md) +* [Column widths](column_widths_example.md) +* [Outlines](column_outlines_example.md) +* [No autowidth](no_autowidth_example.md) + +### Filters + +* [Auto filters](auto_filter_example.md) +* [Filtered tables](filtered_table_example.md) + +### Formulas + +* [Basic formula](basic_formula_example.md) +* [Cached formula](cached_formula_example.md) +* [Escape formula](escape_formula_example.md) +* [Defined name](defined_name_example.md) + +### Media + +* [Image](image_example.md) +* [Locked Image](locked_image_example.md) +* [Hyperlinked Image](hyperlinked_image_example.md) +* [Hyperlinks](hyperlink_example.md) + +### Print + +* [Fit to page print settings](fit_to_page_example.md) +* [Headers and footers](header_footer_example.md) +* [Page breaks](page_break_example.md) +* [Print settings](print_settings_example.md) +* [Repeated header](repeated_header_example.md) + +### Rows + +* [Custom Row Styles](row_styles_example.md) +* [Outlines](row_outlines_example.md) +* [Row heights](row_heights_example.md) + +### Sheet + +* [Active tab](active_tab_example.md) +* [Hide gridlines](hide_gridlines_in_sheet_example.md) +* [Hide sheets](hide_sheet_example.md) +* [Sheet protection](sheet_protection_example.md) +* [Tab colors](tab_color_example.md) + +### Text decorations + +* [Fonts](font_example.md) +* [Format codes](format_codes_example.md) +* [Number formats and currencyc](number_format_example.md) +* [Rich text](rich_text_example.md) +* [Wrap text](wrap_text_example.md) + +### Validations + +* [List validation](list_validation_example.md) +* [Range validation](range_validation_example.md) +* [Text length validation](text_length_validation_example.md) + +### Other features + +* [Comments](comments_example.md) +* [Pivot tables](pivot_table_example.md) |
