thymeleaf / thymeleaf-docs

Thymeleaf documentation
Apache License 2.0
44 stars 54 forks source link

Do not pass --smart to pandoc #65

Closed ghost closed 6 years ago

ghost commented 6 years ago

Building with pandoc 2.2.1 results in the following error: "--smart/-S has been removed. Use +smart or -smart extension instead. For example: pandoc -f markdown+smart -t markdown-smart."

See: jgm/pandoc@6f8b967d98ea4270aa2492688fbcdfe8bad150b2

It should be okay to simply not pass --smart to pandoc because the smart extension is enabled by default for markdown (both input and output): https://pandoc.org/MANUAL.html#extension-smart

ultraq commented 6 years ago

Looks like this is a "recent" addition to pandoc (it's on the 2.0 branch), whereas this whole doc-generation system was put together when 1.x was recent. Looking at the current readme:

You will need version 1.12 or newer of pandoc, as it fixes some important bugs.

😆

I'll do a bit of testing against pandoc 2 and, if it's all good, increase the minimum requirement in the readme as well.

Thanks for this PR, and the other small ones I see you've made against this repo 👍 I'll be giving them a look.

ultraq commented 6 years ago

@danielfernandez, do you think you'll have any time to try out pandoc 2 for the PDFs? I've given it a go for the HTML and I'm happy with the differences that it introduces. If anything, it does a better job in places, eg: we have this piece of markdown indented so it'll be a part of the bullet point, but currently it gets generated unindented:

screen shot 2018-06-04 at 12 34 28 pm

With pandoc 2, that's corrected:

screen shot 2018-06-04 at 12 34 33 pm

Unfortunately for me, PDFs still generate those random square characters, so I can't test with my machine 😕

danielfernandez commented 6 years ago

Sure, let me first update the docs with these changes and also the new Japanese tutorials and I'll try. What would I need to do, just update Pandoc to the latest and run the scripts again?

danielfernandez commented 6 years ago

For the record: this is what we currently have at the releases machine:

pandoc 1.16.0.2
Compiled with texmath 0.8.4.1, highlighting-kate 0.6.1.
ultraq commented 6 years ago

Yep, update only pandoc to the latest version, remove the --smart argument from our build.gradle file like this PR does, and see if the PDFs still look good to you.

When I updated, I ended-up with:

pandoc 2.2.1
Compiled with pandoc-types 1.17.4.2, texmath 0.11, skylighting 0.7.1
danielfernandez commented 6 years ago

Now using:

pandoc 2.2.1
Compiled with pandoc-types 1.17.4.2, texmath 0.11, skylighting 0.7.0.2
Default user data directory: /home/releases/.pandoc
Copyright (C) 2006-2018 John MacFarlane
Web:  http://pandoc.org
This is free software; see the source for copying conditions.
There is no warranty, not even for merchantability or fitness
for a particular purpose.
danielfernandez commented 6 years ago

All docs refreshed and republished. At first sight everything looks OK to me, but it would be great if you (@ultraq) could have a look at the tutorials to see if the changes you expected with the new pandoc version are there (apparently the articles suffered no changes with this rebuild)

danielfernandez commented 6 years ago

Thanks a lot @dtrebbien !