This README.md illustrates all required metadata used by andrew.
| Markdown YAML front matter key | Required | Note |
|---|---|---|
| title | The first <h1> section heading. |
|
| subtitle | Not supported. | |
| author | Retrieve from latest Git commit information. | |
| image | Must be cover.jpg. |
|
| image-alt | Not supported. |
andrew uses Quarto and GitHub uses GitHub Flavored Markdown (GFM) to convert Markdown to HTML. Because Quarto and GFM are not 100% compatible, we provide a comparison of features in the next table.
| Feature | andrew |
GFM | Notes |
|---|---|---|---|
| Pandoc’s Markdown | 👍 | 😥 | |
| Images | 👍 | 👍 | As part of Pandoc’s Markdown. GFM does not support caption. |
| Tables | 👍 | 👍 | As part of Pandoc’s Markdown. GFM does not support caption. |
| Citations and Bibliographies | 👍 | 😭 | As part of Pandoc’s Markdown |
| Footnotes | 👍 | 👍 | As part of Pandoc’s Markdown |
| Math | 👍 | 👍 | Powered by MathJax as part of Pandoc’s Markdown |
| Title Blocks | 👍 | 😭 | Generated by Quarto based on YAML header |
| How to cite in the appendix | 👍 | 😭 | Generated by Quarto based on YAML header |
Although footnotes are supported, the use of footnotes is discouraged[^1].
[^1]: Because of it makes navigation harder.
Math can be written using LaTeX and is render by MathJax. Both inline, for example $x$, and display, for example $$x = \sqrt{a^2 + b^2}\text{,}$$ is supported.
This repository doesn't list any configuration file for Binder and will be launch with the default JupyterLab IDE.