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

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

Open
Roger-Shepherd opened this issue Apr 7, 2021 · 1 comment

Comments

@Roger-Shepherd
Copy link
Contributor

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
Copy link
Contributor

hirooih commented Oct 20, 2021

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
 

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