juliabooks / books.jl Goto Github PK

Is convenient for papers.

The link to https://books.huijzer.xyz/books.pdf in https://books.huijzer.xyz/ leads to 404 error.

This ensures that the image looks the same on the site and in the PDF.

For menu's with lots of text, the spacing is now wrong

Because it's quite annoying to type generate_content all the time and gen should be reasonably unique.

For more information, see https://julialang.org/blog/2019/11/artifacts/.

But do reload the browser. This is to improve speed.

Julia 1.4 as oldest probably

and let user defined config.toml and metadata.yml override the defaults.

This way, it is clear which include is related to what function.

With @sc and @sco, it would also be convenient to specify these via _gen/foo-sc. This suffix is possible because Julia doesn't allow for minus signs in function names while it is allowed in file names. So,

foo_bar() = 3

and calling it via

_gen/foo_bar-sc.md

would show the code for the method f.

To test the quality, add Geom.line and check whether aliasing is clearly visible.

The watcher even includes

• .github/
• .git/
• build/

Lets just remove the subsections from the menu on the left.

And on the long term do something like Bookdown, which is not a priority now.

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

Maybe add a link at the bottom of the page to go to the next or to the previous.

To avoid things like #45.

For Books.jl, it just shows Books - Books.jl on every page.

Let's say I want to work on a little book which supports two languages (en_us, zh_cn). I can create two configs but it seems they share the same index.md, right? How about making it configurable?

This to allow a subset of the computations to be ran.

Occursin:

• content.toml
• dirname
• code (build.jl probably)

Maybe run Julia with sudo privileges?

This allows for running multiple projects at the same time and always at the same port.

I'm not sure if this is intentional. The code snippets included in the index.md file are ignored. It seems

https://github.com/rikhuijzer/Books.jl/blob/f14573f4b614959e4aec5e908cd68738f303fd5d/src/generate.jl#L140

doesn't take the index.md into account.

For Word, this probably means doing md -> md, fixing the md and then md -> word/html.

To allow for a fresh environment.

This basically is stuck on the pip3 cairosvg dependency.

For example, for a DataFrame, provide something which prepares the table according to pandoc-crossref

a   b   c
--- --- ---
1   2   3
4   5   6

: Caption {#tbl:label}

To allow users to specify image size. It could be an ImageOptions struct wrapped around the image. This object can then be passed through convert_output(path, options::Options) because that one converts the objects object to keyword arguments.

function f()
  p = plot()
  imageoptions = ImageOptions(p; width=3cm, height=6cm)
  options = Options(imageoptions; caption="My image")
  return options
end

With this, I don't think it is necessary to also allow for wrapping Options in ImageOptions. When the user does that, try to catch it and show instructions to the user to do it the other way around.

The Pandoc and LaTeX dependencies installation could be moved into Books.jl. Ensure that these installations are not automatically run to mess up the user's system.

code(@code_string f(), f)

with

code(s::AbstractString, f::Function)

Preferably, make this interface a bit easier. So, macro, because we need to wrap the macro?

And the example pages should just be linked to from the Documenter pages.

This improves documentation clarity a lot and allows for different sites per version.

Write test as well.

This is probably a off-by-one error.

Then, users can also host the book while using the GitHub or GitLab Pages domains instead of their own.