Possible to include code files with syntax highlighting?

[matthewfeickert]

I might be getting confused about the differences between what https://github.com/executablebooks/MyST-Parser is capable of now and what https://github.com/executablebooks/mystjs has implemented, but while following and trying to expand the MyST Websites quickstart guide (https://github.com/executablebooks/mystjs-quickstart/tree/ac5b2afa5b560afd7809a25ad8e4c3bc002ca13f) I am trying to add my own example page that would demo the inclusion of code in static files but with relevant syntax highlighting:

# Trying out codeblocks

## Python codeblock

```{code-block} python
:name: my-program
:caption: Creating a TensorMesh using SimPEG
:linenos:
:emphasize-lines: 3,4
from discretize import TensorMesh

hx = [(1, 40)]
hy = [(1, 40)]

mesh = TensorMesh([hx, hy])
```

## Now try with inserted file

```{include} code/example.py
```

$ cat code/example.py
import numpy as np
from discretize import TensorMesh

hx = [(1, 40)]
hy = [(1, 40)]

mesh = TensorMesh([hx, hy])

This of course includes code/example.py but it is not rendered correctly as Python code.

From the myst-parser FAQ it seems like this should be possible to do with

```{literalinclude} code/example.py
:language: python
```

but including this produces the warning

⚠️ 03-code-example.md:24 unknown directive: literalinclude

at myst build.

So is this something that is new enough to be included in the myst-parser spec but not yet implemented in mystjs?

Environment details

$ node --version
v18.16.0
$ npm --version
9.5.1
$ npm info myst-cli version
0.1.31

Context for question

I am trying to understand if mystjs is something that I should look at for a scientific computing focused blog compared to Hugo. If the sort of things that I'm trying to do are a better fit for Jupyter Book than mystjs that would be helpful to know too!

[rowanc1]

Correct, the literalinclude directive is not yet implemented -- a mostly complete list of where mystjs is not yet up to spec with sphinx/jupyter-book is here:
jupyter-book/mystmd#189

I have moved literalinclude to the top of the list! We already support include so it should be pretty simple! I will circle back here when we get it done!

[matthewfeickert]

Excellent. Many thanks for the fast response, @rowanc1!

[rowanc1]

There is now a PR implementing literalinclude here: jupyter-book/mystmd#610 🚀