becarpenter-book6/99. Chapter Template/Markdown Usage.md

Markdown Usage

The basics of using the GitHub dialect of markdown are here. As a general rule, please use the simpler constructs and avoid fancy formatting.

And don't forget, a separate .md file for each new section in any chapter of the book.

Diagrams can be ASCII art when applicable, e.g.:

   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |Version| Traffic Class |           Flow Label                  |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |         Payload Length        |  Next Header  |   Hop Limit   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                              etc.                             |

The mermaid tool can be used for flow charts and state diagrams, e.g.:

```mermaid
flowchart LR
    S[Start here] --> E[End here]
```

flowchart LR
    S[Start here] --> E[End here]

Other types of diagrams could be included using SVG generated by a separate drawing tool such as dia, with the SVG file also stored here on GitHub, e.g.:

<img src="./diag.svg">

Existing diagrams in PNG or JPG format can be inserted in the same way, although SVG has the advantage of being a text format "under the covers".

Previous Next Chapter Contents