Skip to content

Plea for *simple* example of rendering a file with markdown and LaTeX into a PDF or HTML using Documenter.jl #272

@perrinmeyer

Description

@perrinmeyer

I am big fan of literate programing (in theory...), and for many years I used a home-spun vanilla C utility that stripped LaTeX comments out of my source files to run through pdflatex. worked great. However, its the 21st century.

However, I cannot figure out how to get Documenter.jl to create a PDF file from the psm_test.md created by Literate.jl. I really have spent two hours reading the Documenter.jl manual. Its a deep and powerful system, clearly.

Your documentation is well written, but it assumes a level of knowledge of Documenter.jl that I just don't have, and I think other newbies to Julia might not have either. I really want to use Literate.jl for new project. Thank you for your patience and your contributions to Julia.

julia> Literate.markdown("psm_test.jl")

#======================================================================
ok, Julia has multi line comments pound equals ... equals pound...  cool
Literate.jl should turn this into markdown, so this should be **BOLD**

This next math equation is from the Literate.jl documentation 
```math
\int_\Omega \nabla v \cdot \nabla u\ \mathrm{d}\Omega = \int_\Omega v f\ \mathrm{d}\Omega
```
what is magic incantation of Documenter.jl to turn this into a PDF? 
===========================================================================#

using WAV
y,Fs,nbits,stuff = wavread("JolieHollandSacha.wav") # 16bit 44_100Hz sampling (ripped from CD) 
y_int_24 = floor.(Int32,y * 2^23)
wavwrite(y_int_24,"test_WAV_dot_jl__24bit.wav",Fs=44_100,nbits=24,compression=WAVE_FORMAT_PCM)

creates this markdown (which makes sense)

```@meta
EditURL = "psm_test.jl"
```

ok, Julia has multi line comments pound equals ... equals pound...  cool
Literate.jl should turn this into markdown, so this should be **BOLD**

This next math equation is from the Literate.jl documentation
```math
\int_\Omega \nabla v \cdot \nabla u\ \mathrm{d}\Omega = \int_\Omega v f\ \mathrm{d}\Omega
```
what is magic incantation of Documenter.jl to turn this into a PDF?

````@example psm_test
using WAV
y,Fs,nbits,stuff = wavread("JolieHollandSacha.wav") # 16bit 44_100Hz sampling (ripped from CD)
y_int_24 = floor.(Int32,y * 2^23)
wavwrite(y_int_24,"test_WAV_dot_jl__24bit.wav",Fs=44_100,nbits=24,compression=WAVE_FORMAT_PCM)
````

---

*This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).*

But then what is the magic incantation of Documenter.jl that renders this markdown into PDF or HTML (with Math support, of course). Thanks again.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions