documentationhelp wanted
Repository metrics
- Stars
- (334 stars)
- PR merge metrics
- (No merged PRs in 30d)
Description
While I want to write all of this out myself, my hands don't seem to like the idea so much. Here is a table of contents of the things I want to document. Any help with documentation will be hugely appreciated!
Take a look at docs/index.jl, docs/layout.jl, docs/reactive.jl, docs/layout-api.jl to see how documentation can be written.
API Documentation
-
@api&@apidocmacros -
Tile&TileList - Length
- Utility functions
- Layout
- Content
- Typography
- Embellishment
- Signals & Behaviors
- Window
- Higher-order Layouts
User Guide
WIP PR: #67
- Overview
- How to install
- Rules that make Escher
- Under the hood (Optional)
- How to read the manual
- Content
- Text & Markdown
- Code
- LaTeX
- Vector Graphics (with Compose)
- Plots (with Gadfly)
- Tables from dataframes
- Images
- Icons
- Links
- Abbreviations
- Table of Contents (TODO)
- Converting data to
Tile
- Layout
- Sizing and padding
- vbox, hbox
- grow & shrink
- Packing space
- Absolute positioning
- Floating and Image placement (TODO)
- Borders and Colors
- How to use Color.jl
- fillcolor
- borders
- rounded corners
- Typography
- Higher-level typography functions
- Lower-level functions
- Input Widgets
- How to get input
- Tiles of the
Behaviortype - Slider
- Text box
- Checkbox & Toggle button
- Dropdown menu
- Selection (TODO)
- Radio buttons
- CodeMirror
- Pages & higher-order layout
- Pages
- Tabs
- Slideshows
- Toolbars
- Menu
- Items
- Reactive programming & Interactive UIs
- Signals
- Creating signals
- Interpreters
- Maintaining state
- Minesweeper explained