Generate HTML via make4ht #20

fennecJ · 2021-07-30T05:41:07Z

make4ht has a lot of defectors:

When it parsing lkmpg.tex and meet \tableofcontents will throw error
When it parsing lkmpg.tex and meet url with underscore \_, it will output \_
directly instead of _
TOC in generated page isn't as pretty as pdf version
The github action script released by make4ht's team
worked inconsistent with computer side which causing
error when generating github page,and I currently cannot
find a way to generate github page through github action via make4ht.
You can see the result page in here currently.

Makefile

jserv · 2021-07-30T06:00:33Z

Known issue: Underscores can't be used in URLs, as the underscore character is not rendered expectedly.

lkmpg.tex

jserv

It is a directory named "docs."

jserv

Filename "config.cfg" is too generic. Can you use more specific one?

jserv · 2021-07-30T09:48:20Z

Did you use external source files such as CSS? If so, we have to mention the source and clarify the potential licensing terms.

fennecJ · 2021-07-30T09:50:12Z

It is a directory named "docs."

I have modified that commit message, thanks.

fennecJ · 2021-07-30T12:52:52Z

Did you use external source files such as CSS? If so, we have to mention the source and clarify the potential licensing terms.

I remove the whole html /directory . You can generate these files on your own with make html when needed.

Makefile

html.cfg

ekangmonyet · 2021-07-31T08:39:40Z

I'm getting error when rendering the graph at 0.7.3 Manage /proc file with seq_file, is it only me?

XML Parsing Error: mismatched tag. Expected: </g>.
Location: html/lkmpg-1.svg
Line Number 5, Column 44:

fennecJ · 2021-07-31T09:49:56Z

I'm getting error when rendering the graph at 0.7.3 Manage /proc file with seq_file, is it only me?
XML Parsing Error: mismatched tag. Expected: </g>.
Location: html/lkmpg-1.svg
Line Number 5, Column 44:

I don't meet that problem.
You can try using
make4ht -a --debug -suf html5 -c html.cfg -d html lkmpg.tex
to dump full info when parsing the file,
maybe it will provide some hint.
Also check the version of your make4ht and tex.
using command make4ht -v and tex -v to check them.
For my environment

make4ht version v0.3h

TeX 3.141592653 (TeX Live 2021)
kpathsea version 6.3.3

jserv · 2021-07-31T15:10:04Z

I encountered the following errors while running make html:

[ERROR]   htlatex: Compilation errors in the htlatex run
[ERROR]   htlatex: Filename	Line	Message
[ERROR]   htlatex: ./lkmpg.tex 	42	 LaTeX Error: There's no line here to end.

Package information:

$ make4ht -v
make4ht version v0.3g
$ tex -v | head -1
TeX 3.141592653 (TeX Live 2021)

fennecJ · 2021-07-31T15:13:08Z

I encountered the following errors while running make html:

[ERROR]   htlatex: Compilation errors in the htlatex run
[ERROR]   htlatex: Filename	Line	Message
[ERROR]   htlatex: ./lkmpg.tex 	42	 LaTeX Error: There's no line here to end.

Package information:

$ make4ht -v
make4ht version v0.3g
$ tex -v | head -1
TeX 3.141592653 (TeX Live 2021)

Yes, as I mentioned.
When it parsing lkmpg.tex and meet \tableofcontents will throw error
And line 42 is \tableofcontents
But it can still generate html files

Makefile

jserv · 2021-07-31T16:01:33Z

I found a workaround to turn off TOC while generating HTML:

--- a/lkmpg.tex
+++ b/lkmpg.tex
@@ -39,7 +39,12 @@
 \begin{document}
 
 \maketitle
+
+\ifdefined\HCode
+% turn off TOC
+\else
 \tableofcontents
+\fi
 
 \section{Introduction}
 \label{sec:introduction}

Then, I got the message:

[STATUS] make4ht: Conversion finished

fennecJ · 2021-07-31T16:51:25Z

I found a workaround to turn off TOC while generating HTML:
--- a/lkmpg.tex
+++ b/lkmpg.tex
@@ -39,7 +39,12 @@
 \begin{document}
 
 \maketitle
+
+\ifdefined\HCode
+% turn off TOC
+\else
 \tableofcontents
+\fi
 
 \section{Introduction}
 \label{sec:introduction}
Then, I got the message:

[STATUS] make4ht: Conversion finished

That way worked for me too.
However it cause the output html files without TOC.
And I found a way to add back TOC according to this

--- a/html.cfg
+++ b/html.cfg
@@ -1,5 +1,7 @@
 \Preamble{xhtml}
 
+\Configure{tableofcontents*}{chapter,section,subsection}
+

And the generated html files contains TOC again

Hsins · 2021-07-31T21:24:04Z

@fennecJ

I think that you misunderstood something about GitHub Page and make4ht-action.

The Workflow Matters

Let's see the sample main.yml file given by make4ht-action.

name: CI 
on: [push] 
jobs: 
  build: 
   runs-on: ubuntu-latest 
   steps: 
   - uses: actions/checkout@v1 
   - name: Run make4ht 
     uses: docker://ghcr.io/michal-h21/make4ht-action:latest 
     env: 
       command: "make4ht -d out main.tex" 
   - name: Publish the web pages 
     uses:  peaceiris/actions-gh-pages@v3 
     with: 
       github_token: ${{ secrets.GITHUB_TOKEN }} 
       publish_dir: ./out

The workflow do the following tasks whenever there's any "push" event in the repository:

Pull and use the docker image docker://ghcr.io/michal-h21/make4ht-action:latest.
Run the command "make4ht -d out main.tex". This would convert main.tex to main.html and save it in the ./out directory.
Run the actions-gh-pages workflow. This would deploy the files inside publish_dir folder (which set to the ./out folder in this case) to GitHub Pages.

What Should We Do

There're things to be concerned:

The environments (operating system) used by GitHub Actions for executing workflows DON'T have any dependencies (such as texlive, dvipng and also make) be pre-installed.
Though the make4ht-action workflow packs an environment as docker image, it also DON'T have dvipng be pre-installed (it's a pity that dvipng is essential for us).

I create a simple deploy-site.yml here for reference and you can check the created site by visiting https://hsins-fork.github.io/lkmpg/lkmpg.html.

name: Generate HTML and deploy to GitHub Page.

on:
  push:
    branches:
      - master

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    steps:
      - name: checkout branch
        uses: actions/checkout@v2

      - name: install dependencies
        run: |
          sudo apt update
          sudo apt install make texlive-full dvipng
          make html

      - name: deploy site
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./html                                          # --> should be the same as your output folder of make4ht
          publish_branch: gh-pages

Note that:

GitHub Page find index.html in the folder.. Now our output file is lkmpg.html so that the URL would be https://hsins-fork.github.io/lkmpg/lkmpg.html instead of https://hsins-fork.github.io/lkmpg/.
It's not a good practice to hardcode something like sudo apt update and sudo apt install make texlive-full dvipng in the workflow config *.yml file. (try to build the docker image for our repository). Besides, consider just install the packages in need:
```
# (X) texlive-all is too fat and slow down the workflow
$ sudo apt install texlive-full
# (O) just install the packages in need
$ sudo apt install texlive texlive-extra-utils
```
GitHub Pages is designed to host pages from a GitHub repository. And the repository owner (@jserv) need to setup the source branch and folder in Settings > Pages.

fennecJ · 2021-07-31T21:52:16Z

Thanks for @Hsins ’s reply.
I indeed don’t understand github action very well.
I’ll try your script tomorrow.
And for the link issue, according to the document.
I currently don't find a way to assign the output filename when using make4ht
Maybe add
mv ./html/lkmpg.html ./html/index.html into Makefiles?

fennecJ · 2021-08-01T03:55:10Z

@Hsins
I checked the site you generated.
And it looks like several code blocks cannot rendered correctly.
If you run the script on computer side, the result should be looks like
this

ekangmonyet · 2021-08-01T06:08:38Z

@Hsins
I checked the site you generated.
And it looks like several code blocks cannot rendered correctly.
If you run the script on computer side, the result should be looks like
this

What about texlive docker container? This is the locally docker-built version:
https://ekangmonyet.github.io/lkmpg_page_test/lkmpg.html
Or manually install a texlive instead of using the one in ubuntu repository so we have full control over it ...?

Btw I notice that the svg rendered at 0.7.3 is corrupted (both yours and mine):

fennecJ · 2021-08-01T06:35:08Z

@ekangmonyet
Thanks for inform me about corrupted svg.
I just fix that and it rendered correctly now.
lkmpg
As for the container issue, I'll try it in some days.

jserv

Rebase the latest master branch where I removed out-of-date kernel versioning scheme.

jserv

Use "git rebase -i" to rework/squash git commits in preparation for the merging.

jserv

Always use "directory" instead of "folder."
We prefer UNIX flavors.

Makefile

jserv

Improve the git commit messages.
See https://chris.beams.io/posts/git-commit/

Makefile

jserv

Improve the grammar in git commit message. You shall address the motivation and/or the problem you are going to solve at first glance. Then, explain how this patch works.

Makefile

This patch add some scripts which are meant to generate html files successfully using `make4ht`. The target is to build a directory html/ for github page deployment usuage. Problems : When you try using `make4ht -suf html5 -d html lkmpg.tex` to parse the file, you'll find out that make4ht has several defectors: 1. The layout is unsatisfying 2. When it parsing lkmpg.tex and meet \tableofcontents will throw error 3. It generated a lot unneeded files when parsing lkmpg.tex 4. The output filenames are based on input filename and you can't assign them, which is inconvinient cause github page will only recognize the file named `index.html`. Solutions : For problem 1, we can write a config file `html.cfg` to specify the layout style of lkmpg.html with css selectors. For problem 2, we can turn off the \tableofcontents section when using make4ht. However, this cause the output html files without table of contents part. And we can fix this by adding `\Configure{tableofcontents*}{chapter,section,subsection}` into html.cfg so the output html files will contain table of contents again. For problem 3, we can add some delete commands into Makefile. For problem 4, we can add a symbolic link `index.html` lined to `lkmpg.html` Overview of file changes : In html.cfg : Specify the layout of lkmpg.html. Add tables of contents. In Makefile : Add a new target `html` for generating html files and put them in html/ directory. Add a symbolic link `index.html` linked to `lkmpg.html`. Add several `rm` command to get rid of unneeded files. In lkmpg.tex : Turn off the \tableofcontens section when using `make4ht` to prevent from error.

jserv · 2021-08-01T18:43:16Z

Thank @fennecJ for contributing! I amended the commit messages slightly.

fennecJ · 2021-08-01T18:52:02Z

Thanks for applying my PR, I indeed learned a lot during the discussion.

jserv reviewed Jul 30, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

This was referenced Jul 30, 2021

Add Pandoc convert GitHub Page script #17

Closed

feat: Generate PDF/HTML on release event with GitHub Actions #15

Closed

jserv reviewed Jul 30, 2021

View reviewed changes

lkmpg.tex Outdated Show resolved Hide resolved

fennecJ force-pushed the master branch 2 times, most recently from 68c0318 to c9adc25 Compare July 30, 2021 07:18

jserv requested changes Jul 30, 2021

View reviewed changes

fennecJ force-pushed the master branch from c9adc25 to ac5b37e Compare July 30, 2021 09:44

jserv reviewed Jul 31, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

jserv reviewed Jul 31, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

jserv reviewed Jul 31, 2021

View reviewed changes

html.cfg Outdated Show resolved Hide resolved

jserv reviewed Jul 31, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

fennecJ force-pushed the master branch from 0a1380f to f2e223e Compare July 31, 2021 15:22

jserv mentioned this pull request Jul 31, 2021

Use GitHub Actions for site building and format conversion. #25

Open

jserv requested changes Aug 1, 2021

View reviewed changes

fennecJ force-pushed the master branch 2 times, most recently from ee33ae0 to 93ab5f8 Compare August 1, 2021 15:03

jserv requested changes Aug 1, 2021

View reviewed changes

jserv changed the title ~~Add html page via make4ht~~ Generate HTML via make4ht Aug 1, 2021

jserv requested changes Aug 1, 2021

View reviewed changes

jserv reviewed Aug 1, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

fennecJ force-pushed the master branch from 93ab5f8 to 6a06a2c Compare August 1, 2021 15:22

sysprog21 deleted a comment from fennecJ Aug 1, 2021

fennecJ force-pushed the master branch from 6a06a2c to 598bc64 Compare August 1, 2021 15:29

jserv reviewed Aug 1, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

jserv reviewed Aug 1, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

jserv requested changes Aug 1, 2021

View reviewed changes

fennecJ force-pushed the master branch 4 times, most recently from eeb688d to 95cfeeb Compare August 1, 2021 17:19

jserv reviewed Aug 1, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

fennecJ force-pushed the master branch from 95cfeeb to 4fbf305 Compare August 1, 2021 17:32

jserv requested changes Aug 1, 2021

View reviewed changes

jserv reviewed Aug 1, 2021

View reviewed changes

Makefile Outdated Show resolved Hide resolved

fennecJ force-pushed the master branch 2 times, most recently from 76a40e4 to 14587e9 Compare August 1, 2021 18:11

fennecJ force-pushed the master branch from 14587e9 to 9e0b2d9 Compare August 1, 2021 18:12

jserv merged commit 044cfef into sysprog21:master Aug 1, 2021

focaaby mentioned this pull request Aug 1, 2021

Publish GitHub Page with GitHub Action #32

Merged

fennecJ mentioned this pull request Aug 27, 2021

Improve readability #82

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate HTML via make4ht #20

Generate HTML via make4ht #20

fennecJ commented Jul 30, 2021 •

edited

jserv commented Jul 30, 2021 •

edited

jserv left a comment

jserv left a comment

jserv commented Jul 30, 2021

fennecJ commented Jul 30, 2021

fennecJ commented Jul 30, 2021

ekangmonyet commented Jul 31, 2021

fennecJ commented Jul 31, 2021

jserv commented Jul 31, 2021

fennecJ commented Jul 31, 2021 •

edited

jserv commented Jul 31, 2021

fennecJ commented Jul 31, 2021 •

edited

Hsins commented Jul 31, 2021 •

edited

fennecJ commented Jul 31, 2021 •

edited

fennecJ commented Aug 1, 2021 •

edited

ekangmonyet commented Aug 1, 2021

fennecJ commented Aug 1, 2021

jserv left a comment

jserv left a comment

jserv left a comment

jserv left a comment

jserv left a comment

jserv commented Aug 1, 2021

fennecJ commented Aug 1, 2021

Generate HTML via make4ht #20

Generate HTML via make4ht #20

Conversation

fennecJ commented Jul 30, 2021 • edited

jserv commented Jul 30, 2021 • edited

jserv left a comment

Choose a reason for hiding this comment

jserv left a comment

Choose a reason for hiding this comment

jserv commented Jul 30, 2021

fennecJ commented Jul 30, 2021

fennecJ commented Jul 30, 2021

ekangmonyet commented Jul 31, 2021

fennecJ commented Jul 31, 2021

jserv commented Jul 31, 2021

fennecJ commented Jul 31, 2021 • edited

jserv commented Jul 31, 2021

fennecJ commented Jul 31, 2021 • edited

Hsins commented Jul 31, 2021 • edited

The Workflow Matters

What Should We Do

fennecJ commented Jul 31, 2021 • edited

fennecJ commented Aug 1, 2021 • edited

ekangmonyet commented Aug 1, 2021

fennecJ commented Aug 1, 2021

jserv left a comment

Choose a reason for hiding this comment

jserv left a comment

Choose a reason for hiding this comment

jserv left a comment

Choose a reason for hiding this comment

jserv left a comment

Choose a reason for hiding this comment

jserv left a comment

Choose a reason for hiding this comment

jserv commented Aug 1, 2021

fennecJ commented Aug 1, 2021

fennecJ commented Jul 30, 2021 •

edited

jserv commented Jul 30, 2021 •

edited

fennecJ commented Jul 31, 2021 •

edited

fennecJ commented Jul 31, 2021 •

edited

Hsins commented Jul 31, 2021 •

edited

fennecJ commented Jul 31, 2021 •

edited

fennecJ commented Aug 1, 2021 •

edited