open-source-rover icon indicating copy to clipboard operation
open-source-rover copied to clipboard

Figure style

Open sethfischer opened this issue 4 years ago • 3 comments

Figures are displayed in two styles.

  1. Image followed by an emphasized caption:
![](../images/calibration/is6.png)
**Figure 6**
  1. Figure and caption within a table:
| <img src="../../images/pcb_assembly/assembly/standoff_5.png" width="300"> |
|:-:|
| Figure 15: Raspberry Pi Standoffs |

Standardizing on a single style would improve the consistency of the documentation.

sethfischer avatar Jul 05 '21 07:07 sethfischer

Which is the preferred figure style?

sethfischer avatar Jul 05 '21 07:07 sethfischer

The html version is preferred because it allows you to control properties like width and positioning

ericjunkins avatar Jul 05 '21 15:07 ericjunkins

We want to use as much vanilla markdown as possible, but have been deviating in cases where finer control of the figures is necessary, for example when we're placing two large figures next to one another. My personal take is that it's OK to have both. Requiring HTML everywhere would make the contribution threshold even higher and if the basic markdown works, it works :)

Achllle avatar Jan 18 '22 11:01 Achllle