Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How to build tutorial? #61

Open
AlbertoGP opened this issue Oct 19, 2023 · 2 comments
Open

How to build tutorial? #61

AlbertoGP opened this issue Oct 19, 2023 · 2 comments

Comments

@AlbertoGP
Copy link

The Makefile builds the specification, but not the tutorial.

I’ve got it build something by duplicating SPEC_SRC to TUTORIAL_SRC, then:

TUTORIAL_HTML := tutorial/tutorial.html

$(TUTORIAL_HTML): $(TUTORIAL_SRC) _spec/template.html Makefile
	pandoc -t html5 \
		   -f markdown \
		   --template=_spec/template.html \
		   $(PANDOC_FLAGS) --listings --highlight-style=pygments \
		   --mathjax \
		   $(TUTORIAL_SRC) \
		   -o $(TUTORIAL_HTML)

This however does not include the example listings read using {% capture source %}{% include examples/hello-world/hello.aum %}{% endcapture %} and then {{ source }} as is done in hello-world.md for instance.

Maybe this version of pandoc does not have the necessary modules or whatever, but is there some option I’m missing?

@AlbertoGP
Copy link
Author

Maybe that’s not pandoc but jekyll because the include directives look like the liquid template language they use: https://jekyllrb.com/docs/liquid/

@eudoxia0
Copy link
Member

eudoxia0 commented Nov 7, 2023

Yes, the tutorial is "built" entirely with Jekyll. Running it locally should be enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants