doc/README.md doesn't generate html header defining the character set

embench / embench-iot

The main Embench repository

https://www.embench.org/

GNU General Public License v3.0

259 stars 105 forks source link

doc/README.md doesn't generate html header defining the character set #129

Open Roger-Shepherd opened 3 years ago

Roger-Shepherd commented 3 years ago

I've just spent some time trying to track down why when executed in doc, make html produced a file which when rendered by Safari on my Mac didn't render the TM symbol correctly. Long story short, I had the default character encoding set to something other than utf-8. In resolving my problem I saw that WC3 recommends that encodings should be declared in html files.

hirooih commented 3 years ago

I've checked the man page of pandoc. It requires -s (or --standalone) option to generate a valid standalone HTML. Here is the fix.

-- a/doc/Makefile
+++ b/doc/Makefile
@@ -37,7 +37,7 @@ README.pdf: README.md
 html: README.html

 README.html: README.md
-       pandoc -o $@ $^
+       pandoc -s --metadata pagetitle="Embench(TM) User Guide" -o $@ $^

 # Clean up intermediate files