From ffe170f20776b18365c76e6e4e44738692279630 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 26 Feb 2024 09:33:41 +0100 Subject: [PATCH] Add basic-features chaptes --- book/_toc.yml | 1 + book/basic-features/overview.md | 11 +++++++++++ book/features/overview.md | 2 +- 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 book/basic-features/overview.md diff --git a/book/_toc.yml b/book/_toc.yml index a71cba6..bb351e0 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -34,6 +34,7 @@ parts: - file: features/jupyterlite/configuration - file: features/jupyterlite/including-jupyterlite - file: features/h5p.md + - file: basic-features/overview - caption: Examples chapters: - file: examples/overview \ No newline at end of file diff --git a/book/basic-features/overview.md b/book/basic-features/overview.md new file mode 100644 index 0000000..1dd46cd --- /dev/null +++ b/book/basic-features/overview.md @@ -0,0 +1,11 @@ +# Basic Features + +```{warning} Under Construction! + +This page will provide a list of some commonly used book features which are all available in the original jupyter book package. However, this page includes best-practises on how to use them. +``` + +Things to include somewhere: +- use the right HTML tags for images (described {ref}`here `) +- watch out for `png` versus `PNG` +- 2 interesting comments from Quinten about MyST extensions in [this GL Issue](https://gitlab.tudelft.nl/mude/archive-2022/-/issues/25#note_163123) diff --git a/book/features/overview.md b/book/features/overview.md index 95824d8..51fb44a 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -1,4 +1,4 @@ -# Book Features +# CEG-book Features ```{warning} Under Construction!