Include external, raw file #773

lukaslueg · 2018-08-24T21:36:36Z

I'm sorry if this is obvious, I couldn't figure it out, though: Putting a thought into rust-lang/reference#398, one could include a SVG into the book which reacts to the book's CSS variables to stay on par with the theme chosen by the user. This however would require one to include the SVG directly into the final HTML (that is, instead of <object or <img), so that the CSS inherited from mdbook's <body> actually applies.

I can see no way to include a raw, external file into a book's final HTML, given a .md as the starting point. The provided {{#include }} seems to tinker quite a lot with file's content and it destroys the SVG's syntax.

Is there a way to pull raw, external stuff into the final HTML, with .md as the starting point and without using the API ?

The text was updated successfully, but these errors were encountered:

tiby312 · 2021-01-31T13:53:22Z

I have a similar situation where I want to insert SVG graphs that adapt to the current theme. Would be great if there were a {{#include_raw }} to just embed files directly.

tiby312 · 2021-01-31T17:35:15Z

Actually I was able to use {{#include foo.svg}} by making sure the contents inside of the <style> tag did not trigger any special markdown processing. This meant not using css comments /* comment */ and by not leaving any spaces between lines so as to not trigger it to add a <p>. So you can use it to embed SVG, provided you are really careful up your <style> tag not trigger any special markdown. If you compress/minify your SVG, it might just work.

tiby312 · 2021-01-31T17:41:05Z

Instead of making a {{#include_raw }}, maybe the best option is for {{#include }} to detect when it is getting called inside of a html context, in which case it doesnt modify what it is being inserted. So user would have to do this:

<div>
{{#include_raw foo.svg}}
</div>

- Enhance TOC - Solves some warnings seen here: https://github.com/UniMath/agda-unimath/actions/runs/4991616992/jobs/8939272325#step:12:1304 - Closes #614 - Removes the background from the agda logo. I tried syncing SVG stroke colours with agda-logo.css (so it responds to the colour theme), but no luck yet. We need more time to figure it out. the following is related and the suggestion included in my experiment. - rust-lang/mdBook#773 --------- Co-authored-by: Fredrik Bakke <fredrbak@gmail.com>

- Enhance TOC - Solves some warnings seen here: https://github.com/UniMath/agda-unimath/actions/runs/4991616992/jobs/8939272325#step:12:1304 - Closes UniMath#614 - Removes the background from the agda logo. I tried syncing SVG stroke colours with agda-logo.css (so it responds to the colour theme), but no luck yet. We need more time to figure it out. the following is related and the suggestion included in my experiment. - rust-lang/mdBook#773 --------- Co-authored-by: Fredrik Bakke <fredrbak@gmail.com>

commit 3b74252 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 22:51:21 2023 -0400 fix indentation commit 880504d Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 21:03:31 2023 -0400 remove punctuation at end of headers commit cb2a09c Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 21:03:15 2023 -0400 pre-commit autoremove punctuation at end of header commit f19934c Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 20:52:42 2023 -0400 add remarks about missing contents commit 582e75c Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 20:34:57 2023 -0400 pre-commit detect empty sections at end of file commit 3d53688 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 19:45:19 2023 -0400 remove empty code blocks commit 437056c Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 19:45:04 2023 -0400 compatibility markdown-conventions and fix-imports commit 8c7f782 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 27 19:38:57 2023 -0400 pre-commit autoremove empty code blocks commit 6f84849 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 14:28:44 2023 +0200 fix some indentation and then give up for the moment commit ccdad61 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 14:05:31 2023 +0200 add `indentation_conventions.py` commit ba930b4 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 13:33:11 2023 +0200 rename pre-commit scripts commit 2cd2433 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 13:09:02 2023 +0200 Add and enforce section conventions commit db60c6f Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 12:07:41 2023 +0200 rename `remove_extra_blank_lines.py` to `blank_line_conventions.py` commit 0d1f085 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 12:05:11 2023 +0200 Fix top section headers not at start of file commit 986a68d Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 11:52:20 2023 +0200 swap to using `_-ℤ_` commit cea0cf6 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 10:53:52 2023 +0200 define infix operator `_-ℤ_` for difference commit b2cd359 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 10:44:42 2023 +0200 Fix empty subsubsections commit ecd6061 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 10:05:23 2023 +0200 fix empty subsections commit 3823a10 Merge: 23e5534 92c52ba Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sun May 21 06:43:30 2023 +0200 Merge branch 'UniMath:master' into modalities3 commit 23e5534 Author: Jonathan Cubides <jonathan.cubides@uib.no> Date: Fri May 19 01:04:26 2023 +0200 Fix: missing logo (UniMath#625) Minor fix due to a local cache issue commit 0ba07cd Author: Jonathan Cubides <jonathan.cubides@uib.no> Date: Fri May 19 00:09:46 2023 +0200 Enable TOC and fix minor warnings (UniMath#602) - Enhance TOC - Solves some warnings seen here: https://github.com/UniMath/agda-unimath/actions/runs/4991616992/jobs/8939272325#step:12:1304 - Closes UniMath#614 - Removes the background from the agda logo. I tried syncing SVG stroke colours with agda-logo.css (so it responds to the colour theme), but no luck yet. We need more time to figure it out. the following is related and the suggestion included in my experiment. - rust-lang/mdBook#773 --------- Co-authored-by: Fredrik Bakke <fredrbak@gmail.com> commit 9b80ef0 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 13 20:29:54 2023 +0200 Remove unused imports and fix some unaddressed comments (UniMath#621) Sorry, my script wasn't finished when I made the last commit in UniMath#620, and here are the remaining unused imports. This PR also fixes some comments I made earlier that went unaddressed. I'm wondering, are the imports scripts interfering with people's merging process a lot? If so, we don't have to merge those changes now. commit 3b658d0 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 13 19:14:02 2023 +0200 Refactor to use infix binary operators for arithmetic (UniMath#620) - Refactor to use infix binary operators for arithmetic. - Define infix binary operators for arithmetic operations on the Eisenstein integers, Gaussian integers,half integers, and truncation levels. - Swap to using left/right instead of a `'` for different laws for binary arithmetic operators. - Some additional refactoring for Eisenstein integers and Gaussian integers Note that the non-infix variants of the operators are still used some places, matching how `Id` and `pair` are used. commit f77b71e Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 13 14:39:13 2023 +0200 Define binary operator notations for `mul-ℕ`, `mul-ℤ`, and `exp-ℕ`. (UniMath#618) They are `_*ℕ_`, `_*ℤ_`, and `_^ℕ_` respectively. In addition to what the title says, I've also refactored the files - `multiplication-natural-numbers` - `multiplication-integers` - `exponentiation-natural-numbers` - `absolute-value-integers` to use the binary operators where it's natural, to get a sense for how this would look. It should be possible to change most usages easily enough* with a nice enough regex, but I don't want to do this before I get some feedback on whether it is preferable. Also, pairs like `is-injective-mul-succ-ℕ` and `is-injective-mul-succ-ℕ'` should perhaps be renamed to something like `is-injective-left-mul-succ-ℕ` and `is-injective-right-mul-succ-ℕ`. commit ee5a96c Author: Egbert Rijke <e.m.rijke@gmail.com> Date: Fri May 12 00:52:35 2023 +0200 Subframes and quotient locales via nuclei (UniMath#613) commit 750f151 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 20 17:16:03 2023 +0200 small fixes commit e1f3af4 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 20 00:40:58 2023 +0200 add `is-emb-map-prod` commit 973a00f Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 20 00:40:29 2023 +0200 fix expressions in some headers commit e3f8a25 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Tue May 16 14:05:02 2023 +0200 Swap from `md` to `text` code blocks (UniMath#622) - Fix diagrams in `pullback-hom` - Swap from `md` to `text` code blocks - Register Collatz' bijection in the OEIS file commit c7398a7 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 13 20:29:54 2023 +0200 Remove unused imports and fix some unaddressed comments (UniMath#621) Sorry, my script wasn't finished when I made the last commit in UniMath#620, and here are the remaining unused imports. This PR also fixes some comments I made earlier that went unaddressed. I'm wondering, are the imports scripts interfering with people's merging process a lot? If so, we don't have to merge those changes now. commit 001e8d7 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 13 19:14:02 2023 +0200 Refactor to use infix binary operators for arithmetic (UniMath#620) - Refactor to use infix binary operators for arithmetic. - Define infix binary operators for arithmetic operations on the Eisenstein integers, Gaussian integers,half integers, and truncation levels. - Swap to using left/right instead of a `'` for different laws for binary arithmetic operators. - Some additional refactoring for Eisenstein integers and Gaussian integers Note that the non-infix variants of the operators are still used some places, matching how `Id` and `pair` are used. commit fde878d Author: Fredrik Bakke <fredrbak@gmail.com> Date: Sat May 13 14:39:13 2023 +0200 Define binary operator notations for `mul-ℕ`, `mul-ℤ`, and `exp-ℕ`. (UniMath#618) They are `_*ℕ_`, `_*ℤ_`, and `_^ℕ_` respectively. In addition to what the title says, I've also refactored the files - `multiplication-natural-numbers` - `multiplication-integers` - `exponentiation-natural-numbers` - `absolute-value-integers` to use the binary operators where it's natural, to get a sense for how this would look. It should be possible to change most usages easily enough* with a nice enough regex, but I don't want to do this before I get some feedback on whether it is preferable. Also, pairs like `is-injective-mul-succ-ℕ` and `is-injective-mul-succ-ℕ'` should perhaps be renamed to something like `is-injective-left-mul-succ-ℕ` and `is-injective-right-mul-succ-ℕ`. commit 76bf8c7 Author: Egbert Rijke <e.m.rijke@gmail.com> Date: Fri May 12 00:52:35 2023 +0200 Subframes and quotient locales via nuclei (UniMath#613) commit 375210c Author: VictorBlanchi <76261859+VictorBlanchi@users.noreply.github.com> Date: Thu May 11 16:49:27 2023 +0200 Iterated cartesian product is closed by permutation (UniMath#617) I have shown that the 3 definitions of iterated cartesian product of types is closed by permutation. commit 730861a Author: Fredrik Bakke <fredrbak@gmail.com> Date: Thu May 11 15:51:39 2023 +0200 alignment of pullback-hom diagrams commit dab6d30 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Thu May 11 12:33:08 2023 +0200 some nitpicking commit 469dba3 Author: Fredrik Bakke <fredrbak@gmail.com> Date: Wed May 10 21:08:12 2023 +0200 wording `26-descent`

whitequark · 2024-03-19T16:54:24Z

I have found a very compact solution to enable SVG images to be rendered nicely with a dark theme that doesn't rely on #include or preprocessors: a small extra CSS file that sets img { color-scheme: light | dark; } appropriately, with one rule per theme, and a small modification to the SVG files that looks like this (the exact rules depend on the SVG file contents but can usually be discovered easily):

  <defs>
    <style>
      :root { color: #1e1e1e; }
      @media (prefers-color-scheme: dark) {
        :root { color: #d3d3d3; }
      }
    </style>
  </defs>

While decidedly not perfect, it's flexible and leaves the <img> tags in the source Markdown so that they can be rendered by GitHub. (And yes, the GitHub Markdown preview is legible too!)

You can see it in action in amaranth-lang/rfcs@43f8f04.

tomeichlersmith · 2024-09-05T19:33:50Z

I also would like this feature but from a different point of view.

I have a project and I would like to include its man pages in the online mdbook render. My current solution is to use pandoc to convert the man pages into markdown which are then included in the mdbook source, but this produces man pages that look pretty different that what is seen on the command line when running man ...). Other tools are already able to process man pages into HTML persisting the layout and look (namely, aha can do this with MAN_KEEP_FORMATTING=1 COLUMNS=80 man aha | ul | aha > man-aha.html). Using the {{ #include ... }} with these files mangles the ascii-style layout (most obviously converting indented lines to code blocks). This mangling is still done when using a preprocessor like mdbook-cmdrun to inject the HTML directly into the markdown (what I presume the {{ #include }} is doing as well).

tomeichlersmith · 2024-09-05T21:03:45Z

I was able to get a solution for my situation after reading the common mark spec on HTML blocks. I am using the cmdrun preprocessor and wrapping the resulting headerless HTML with the pre HTML tag.

The entire contents of my file are then

<pre>
<!-- cmdrun MAN_KEEP_FORMATTING=1 COLUMNS=80 man path/to/man.1 | ul | aha --no-header -->
</pre>

which is then rendered as if the aha-generated HTML was placed within the boundaries of the mdbook sidebar and top bar 😄

I still support the possibility of bypassing the common-mark spec and, in general, having a solution for including some sort of "pre-generated" or "raw" files that can be included without further modification by the cmark markdown->html translation.

ehuss added the A-link-preprocessor Area: Link preprocessor, #{{include}}, etc. label Apr 22, 2020

max-sixty mentioned this issue Apr 5, 2022

Is it possible to embed a small wasm app in an mdbook? #1780

Closed

ericthelemur mentioned this issue Jul 24, 2022

Images have a white background even with dark themes rust-lang/book#74

Open

jonaprieto mentioned this issue May 18, 2023

Enable TOC and fix minor warnings UniMath/agda-unimath#602

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Include external, raw file #773

Include external, raw file #773

lukaslueg commented Aug 24, 2018

tiby312 commented Jan 31, 2021

tiby312 commented Jan 31, 2021 •

edited

Loading

tiby312 commented Jan 31, 2021 •

edited

Loading

whitequark commented Mar 19, 2024 •

edited

Loading

tomeichlersmith commented Sep 5, 2024

tomeichlersmith commented Sep 5, 2024 •

edited

Loading

Include external, raw file #773

Include external, raw file #773

Comments

lukaslueg commented Aug 24, 2018

tiby312 commented Jan 31, 2021

tiby312 commented Jan 31, 2021 • edited Loading

tiby312 commented Jan 31, 2021 • edited Loading

whitequark commented Mar 19, 2024 • edited Loading

tomeichlersmith commented Sep 5, 2024

tomeichlersmith commented Sep 5, 2024 • edited Loading

tiby312 commented Jan 31, 2021 •

edited

Loading

tiby312 commented Jan 31, 2021 •

edited

Loading

whitequark commented Mar 19, 2024 •

edited

Loading

tomeichlersmith commented Sep 5, 2024 •

edited

Loading