diff mbox series

[3/3] secilc/docs: disable pandoc default css for html docs

Message ID 89653753-717f-3ef9-9538-c90ad2aa62b1@gmail.com (mailing list archive)
State Accepted
Commit 02bdee369c0b
Headers show
Series [1/3] secilc/docs: selinuxuser actually takes a string not identifier | expand

Commit Message

bauen1 Aug. 28, 2022, 12:14 p.m. UTC 
Some time ago pandoc started shipping a default css file for html, while
that is nice, it limits the max-width of the body element to 36em. We
have a lot of tables, code examples, etc... in the manual that are too
big for that, requiring constant scrolling.

See https://github.com/jgm/pandoc/blob/master/data/templates/styles.html
for the default used.

While some styling, perhaps even dark/light mode support in the CSS
would be nice, I didn't manage to find a simple way to achieve this, so
for now just disable the CSS.

Expand the arguments for pandoc in the Makefile for better readability.

Signed-off-by: Jonathan Hettwer (bauen1) <j2468h@gmail.com>
---
  secilc/docs/Makefile | 18 ++++++++++++++++--
  1 file changed, 16 insertions(+), 2 deletions(-)

--
2.36.1

Comments

James Carter Aug. 31, 2022, 11:55 a.m. UTC | #1 
On Sun, Aug 28, 2022 at 8:16 AM bauen1 <j2468h@googlemail.com> wrote:
>
> Some time ago pandoc started shipping a default css file for html, while
> that is nice, it limits the max-width of the body element to 36em. We
> have a lot of tables, code examples, etc... in the manual that are too
> big for that, requiring constant scrolling.
>
> See https://github.com/jgm/pandoc/blob/master/data/templates/styles.html
> for the default used.
>
> While some styling, perhaps even dark/light mode support in the CSS
> would be nice, I didn't manage to find a simple way to achieve this, so
> for now just disable the CSS.
>
> Expand the arguments for pandoc in the Makefile for better readability.
>
> Signed-off-by: Jonathan Hettwer (bauen1) <j2468h@gmail.com>

Acked-by: James Carter <jwcart2@gmail.com>

> ---
>   secilc/docs/Makefile | 18 ++++++++++++++++--
>   1 file changed, 16 insertions(+), 2 deletions(-)
>
> diff --git a/secilc/docs/Makefile b/secilc/docs/Makefile
> index a03ebeed..7e2ba40e 100644
> --- a/secilc/docs/Makefile
> +++ b/secilc/docs/Makefile
> @@ -58,11 +58,25 @@ $(TMPDIR)/policy.cil: $(TESTDIR)/policy.cil
>
>   html: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml
>         mkdir -p $(HTMLDIR)
> -       $(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --metadata title="CIL Reference Guide" -t html $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil  -o $(HTMLDIR)/$(HTML_OUT)
> +       $(PANDOC) \
> +               --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) \
> +               --syntax-definition=secil.xml \
> +               --standalone \
> +               --metadata title="CIL Reference Guide" \
> +               --metadata document-css=false \
> +               -t html \
> +               $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil \
> +               -o $(HTMLDIR)/$(HTML_OUT)
>
>   pdf: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml
>         mkdir -p $(PDFDIR)
> -       $(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --toc $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil -o $(PDFDIR)/$(PDF_OUT)
> +       $(PANDOC) \
> +               --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) \
> +               --syntax-definition=secil.xml \
> +               --standalone \
> +               --toc \
> +               $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil \
> +               -o $(PDFDIR)/$(PDF_OUT)
>
>   clean:
>         rm -rf $(HTMLDIR)
> --
> 2.36.1
>
James Carter Sept. 1, 2022, 7:58 p.m. UTC | #2 
On Wed, Aug 31, 2022 at 7:55 AM James Carter <jwcart2@gmail.com> wrote:
>
> On Sun, Aug 28, 2022 at 8:16 AM bauen1 <j2468h@googlemail.com> wrote:
> >
> > Some time ago pandoc started shipping a default css file for html, while
> > that is nice, it limits the max-width of the body element to 36em. We
> > have a lot of tables, code examples, etc... in the manual that are too
> > big for that, requiring constant scrolling.
> >
> > See https://github.com/jgm/pandoc/blob/master/data/templates/styles.html
> > for the default used.
> >
> > While some styling, perhaps even dark/light mode support in the CSS
> > would be nice, I didn't manage to find a simple way to achieve this, so
> > for now just disable the CSS.
> >
> > Expand the arguments for pandoc in the Makefile for better readability.
> >
> > Signed-off-by: Jonathan Hettwer (bauen1) <j2468h@gmail.com>
>
> Acked-by: James Carter <jwcart2@gmail.com>
>

This patch has been merged.
Thanks,
Jim

> > ---
> >   secilc/docs/Makefile | 18 ++++++++++++++++--
> >   1 file changed, 16 insertions(+), 2 deletions(-)
> >
> > diff --git a/secilc/docs/Makefile b/secilc/docs/Makefile
> > index a03ebeed..7e2ba40e 100644
> > --- a/secilc/docs/Makefile
> > +++ b/secilc/docs/Makefile
> > @@ -58,11 +58,25 @@ $(TMPDIR)/policy.cil: $(TESTDIR)/policy.cil
> >
> >   html: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml
> >         mkdir -p $(HTMLDIR)
> > -       $(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --metadata title="CIL Reference Guide" -t html $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil  -o $(HTMLDIR)/$(HTML_OUT)
> > +       $(PANDOC) \
> > +               --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) \
> > +               --syntax-definition=secil.xml \
> > +               --standalone \
> > +               --metadata title="CIL Reference Guide" \
> > +               --metadata document-css=false \
> > +               -t html \
> > +               $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil \
> > +               -o $(HTMLDIR)/$(HTML_OUT)
> >
> >   pdf: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml
> >         mkdir -p $(PDFDIR)
> > -       $(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --toc $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil -o $(PDFDIR)/$(PDF_OUT)
> > +       $(PANDOC) \
> > +               --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) \
> > +               --syntax-definition=secil.xml \
> > +               --standalone \
> > +               --toc \
> > +               $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil \
> > +               -o $(PDFDIR)/$(PDF_OUT)
> >
> >   clean:
> >         rm -rf $(HTMLDIR)
> > --
> > 2.36.1
> >
diff mbox series

Patch

diff --git a/secilc/docs/Makefile b/secilc/docs/Makefile
index a03ebeed..7e2ba40e 100644
--- a/secilc/docs/Makefile
+++ b/secilc/docs/Makefile
@@ -58,11 +58,25 @@  $(TMPDIR)/policy.cil: $(TESTDIR)/policy.cil

  html: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml
  	mkdir -p $(HTMLDIR)
-	$(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --metadata title="CIL Reference Guide" -t html $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil  -o $(HTMLDIR)/$(HTML_OUT)
+	$(PANDOC) \
+		--highlight-style=$(PANDOC_HIGHLIGHT_STYLE) \
+		--syntax-definition=secil.xml \
+		--standalone \
+		--metadata title="CIL Reference Guide" \
+		--metadata document-css=false \
+		-t html \
+		$(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil \
+		-o $(HTMLDIR)/$(HTML_OUT)

  pdf: $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil secil.xml
  	mkdir -p $(PDFDIR)
-	$(PANDOC) --highlight-style=$(PANDOC_HIGHLIGHT_STYLE) --syntax-definition=secil.xml --standalone --toc $(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil -o $(PDFDIR)/$(PDF_OUT)
+	$(PANDOC) \
+		--highlight-style=$(PANDOC_HIGHLIGHT_STYLE) \
+		--syntax-definition=secil.xml \
+		--standalone \
+		--toc \
+		$(PANDOC_FILE_LIST) $(TMPDIR)/policy.cil \
+		-o $(PDFDIR)/$(PDF_OUT)

  clean:
  	rm -rf $(HTMLDIR)