summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPiotr Brzeziński <piotr@centricular.com>2024-04-12 10:35:45 +0200
committerPiotr Brzeziński <piotr@centricular.com>2024-04-17 19:28:28 +0200
commit28037a5b734b8f374e3592571e1784e75bcd4090 (patch)
treefe66411f9966fb9479ee0fe258513f8f21ab6784
parent1fa760f72fa8e84234becefcccb862e1511ab21d (diff)
www: Move from markdown to cmark-gfm
Needed mainly to allow parsing markdown inside some basic HTML block tags (the old markdown tool does not allow that). Also allows for some useful extensions, like markdown tables, strikethrough etc. Part-of: <https://gitlab.freedesktop.org/gstreamer/www/-/merge_requests/104>
-rw-r--r--.gitlab-ci.yml4
-rw-r--r--HACKING4
-rw-r--r--src/configure.ac3
-rw-r--r--src/htdocs/download/Makefile.am2
-rw-r--r--src/htdocs/releases/1.10/Makefile.am2
-rw-r--r--src/htdocs/releases/1.12/Makefile.am2
-rw-r--r--src/htdocs/releases/1.14/Makefile.am2
-rw-r--r--src/htdocs/releases/1.16/Makefile.am2
-rw-r--r--src/htdocs/releases/1.18/Makefile.am2
-rw-r--r--src/htdocs/releases/1.20/Makefile.am2
-rw-r--r--src/htdocs/releases/1.22/Makefile.am2
-rw-r--r--src/htdocs/releases/1.24/Makefile.am2
-rw-r--r--src/htdocs/releases/1.6/Makefile.am2
-rw-r--r--src/htdocs/releases/1.8/Makefile.am2
-rw-r--r--src/htdocs/releases/Makefile.am2
15 files changed, 19 insertions, 16 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 1d60e700..1edfb02e 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -18,7 +18,7 @@ variables:
WWW_AMD64_SUFFIX: 'amd64/www'
- WWW_TAG: '2024-03-12.0'
+ WWW_TAG: '2024-04-12.0'
workflow:
# https://docs.gitlab.com/ee/ci/yaml/index.html#switch-between-branch-pipelines-and-merge-request-pipelines
@@ -57,7 +57,7 @@ default:
FDO_DISTRIBUTION_VERSION: 'bookworm'
FDO_REPO_SUFFIX: "$WWW_AMD64_SUFFIX"
FDO_DISTRIBUTION_TAG: "$WWW_TAG-$GST_UPSTREAM_BRANCH"
- FDO_DISTRIBUTION_PACKAGES: 'automake autoconf make markdown xsltproc w3c-sgml-lib ca-certificates'
+ FDO_DISTRIBUTION_PACKAGES: 'automake autoconf make cmark-gfm xsltproc w3c-sgml-lib ca-certificates'
#FDO_DISTRIBUTION_EXEC: 'ci/docker/prepare.sh'
www amd64 docker:
diff --git a/HACKING b/HACKING
index 5694b018..af5e7978 100644
--- a/HACKING
+++ b/HACKING
@@ -1,7 +1,7 @@
To hack on the GStreamer website, here's what to do:
-0) Install the markdown tool (the original John Gruber markdown.pl script as an
- executable named "markdown", available on Debian via the markdown package)
+0) Install the cmark-gfm tool (via your package manager or from
+ https://github.com/github/cmark-gfm) for markdown support
1) Check out the www module
2) src/autogen.sh
3) create src/htdocs/entities.site by symlinking the applicable entities file
diff --git a/src/configure.ac b/src/configure.ac
index 559855b4..5839e497 100644
--- a/src/configure.ac
+++ b/src/configure.ac
@@ -4,6 +4,9 @@ AM_INIT_AUTOMAKE
AC_SUBST(XSLTPROC_ARGS, [-nonet])
+# Enable raw HTML and the tables extension for markdown
+AC_SUBST(CMARK_ARGS, ["--unsafe -e table"])
+
AC_CONFIG_FILES([
Makefile
htdocs/Makefile
diff --git a/src/htdocs/download/Makefile.am b/src/htdocs/download/Makefile.am
index 31e07eee..1b93d107 100644
--- a/src/htdocs/download/Makefile.am
+++ b/src/htdocs/download/Makefile.am
@@ -5,6 +5,6 @@ index.html: download.html index.xml $(fullstyle) $(entities) $(page_style) $(pic
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
download.html: download.md
- markdown $(srcdir)/download.md > $(builddir)/download.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/download.md > $(builddir)/download.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/1.10/Makefile.am b/src/htdocs/releases/1.10/Makefile.am
index cea7f425..01f6ddf5 100644
--- a/src/htdocs/releases/1.10/Makefile.am
+++ b/src/htdocs/releases/1.10/Makefile.am
@@ -7,6 +7,6 @@ index.html: release-notes-1.10.html index.xml $(fullstyle) $(entities) $(page_st
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
release-notes-1.10.html: release-notes-1.10.md
- markdown $(srcdir)/release-notes-1.10.md > $(builddir)/release-notes-1.10.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.10.md > $(builddir)/release-notes-1.10.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/1.12/Makefile.am b/src/htdocs/releases/1.12/Makefile.am
index 02cc114a..efa2b94d 100644
--- a/src/htdocs/releases/1.12/Makefile.am
+++ b/src/htdocs/releases/1.12/Makefile.am
@@ -7,6 +7,6 @@ index.html: release-notes-1.12.html index.xml $(fullstyle) $(entities) $(page_st
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
release-notes-1.12.html: release-notes-1.12.md
- markdown $(srcdir)/release-notes-1.12.md > $(builddir)/release-notes-1.12.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.12.md > $(builddir)/release-notes-1.12.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/1.14/Makefile.am b/src/htdocs/releases/1.14/Makefile.am
index e4d93e36..92659a25 100644
--- a/src/htdocs/releases/1.14/Makefile.am
+++ b/src/htdocs/releases/1.14/Makefile.am
@@ -7,6 +7,6 @@ index.html: release-notes-1.14.html index.xml $(fullstyle) $(entities) $(page_st
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
release-notes-1.14.html: release-notes-1.14.md
- markdown $(srcdir)/release-notes-1.14.md > $(builddir)/release-notes-1.14.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.14.md > $(builddir)/release-notes-1.14.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/1.16/Makefile.am b/src/htdocs/releases/1.16/Makefile.am
index 2fc7468b..8f1aaa46 100644
--- a/src/htdocs/releases/1.16/Makefile.am
+++ b/src/htdocs/releases/1.16/Makefile.am
@@ -7,6 +7,6 @@ index.html: release-notes-1.16.html index.xml $(fullstyle) $(entities) $(page_st
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
release-notes-1.16.html: release-notes-1.16.md
- markdown $(srcdir)/release-notes-1.16.md > $(builddir)/release-notes-1.16.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.16.md > $(builddir)/release-notes-1.16.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/1.18/Makefile.am b/src/htdocs/releases/1.18/Makefile.am
index 7e44628a..729c3707 100644
--- a/src/htdocs/releases/1.18/Makefile.am
+++ b/src/htdocs/releases/1.18/Makefile.am
@@ -4,7 +4,7 @@ built_pages = index.html
pics =
release-notes-1.18.html: release-notes-1.18.md
- markdown $(srcdir)/release-notes-1.18.md > $(builddir)/release-notes-1.18.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.18.md > $(builddir)/release-notes-1.18.html
index.html: release-notes-1.18.html index.xml $(fullstyle) $(entities) $(page_style) $(pics)
for pic in $(pics); do cp $(srcdir)/$$pic $(builddir)/$$pic; done
diff --git a/src/htdocs/releases/1.20/Makefile.am b/src/htdocs/releases/1.20/Makefile.am
index 01a5796d..a69c89e5 100644
--- a/src/htdocs/releases/1.20/Makefile.am
+++ b/src/htdocs/releases/1.20/Makefile.am
@@ -4,7 +4,7 @@ built_pages = index.html
pics =
release-notes-1.20.html: release-notes-1.20.md
- markdown $(srcdir)/release-notes-1.20.md > $(builddir)/release-notes-1.20.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.20.md > $(builddir)/release-notes-1.20.html
index.html: release-notes-1.20.html index.xml $(fullstyle) $(entities) $(page_style) $(pics)
for pic in $(pics); do cp $(srcdir)/$$pic $(builddir)/$$pic; done
diff --git a/src/htdocs/releases/1.22/Makefile.am b/src/htdocs/releases/1.22/Makefile.am
index fe66f59e..623de126 100644
--- a/src/htdocs/releases/1.22/Makefile.am
+++ b/src/htdocs/releases/1.22/Makefile.am
@@ -4,7 +4,7 @@ built_pages = index.html
pics =
release-notes-1.22.html: release-notes-1.22.md
- markdown $(srcdir)/release-notes-1.22.md > $(builddir)/release-notes-1.22.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.22.md > $(builddir)/release-notes-1.22.html
index.html: release-notes-1.22.html index.xml $(fullstyle) $(entities) $(page_style) $(pics)
for pic in $(pics); do cp $(srcdir)/$$pic $(builddir)/$$pic; done
diff --git a/src/htdocs/releases/1.24/Makefile.am b/src/htdocs/releases/1.24/Makefile.am
index 0f22ee0d..6d5105b0 100644
--- a/src/htdocs/releases/1.24/Makefile.am
+++ b/src/htdocs/releases/1.24/Makefile.am
@@ -4,7 +4,7 @@ built_pages = index.html
pics =
release-notes-1.24.html: release-notes-1.24.md
- markdown $(srcdir)/release-notes-1.24.md > $(builddir)/release-notes-1.24.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.24.md > $(builddir)/release-notes-1.24.html
index.html: release-notes-1.24.html index.xml $(fullstyle) $(entities) $(page_style) $(pics)
for pic in $(pics); do cp $(srcdir)/$$pic $(builddir)/$$pic; done
diff --git a/src/htdocs/releases/1.6/Makefile.am b/src/htdocs/releases/1.6/Makefile.am
index 7e46fbc8..8fb4eb74 100644
--- a/src/htdocs/releases/1.6/Makefile.am
+++ b/src/htdocs/releases/1.6/Makefile.am
@@ -17,6 +17,6 @@ index.html: release-notes-1.6.html index.xml $(fullstyle) $(entities) $(page_sty
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
release-notes-1.6.html: release-notes-1.6.md
- markdown $(srcdir)/release-notes-1.6.md > $(builddir)/release-notes-1.6.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.6.md > $(builddir)/release-notes-1.6.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/1.8/Makefile.am b/src/htdocs/releases/1.8/Makefile.am
index 79693c94..ca7fd304 100644
--- a/src/htdocs/releases/1.8/Makefile.am
+++ b/src/htdocs/releases/1.8/Makefile.am
@@ -7,6 +7,6 @@ index.html: release-notes-1.8.html index.xml $(fullstyle) $(entities) $(page_sty
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
release-notes-1.8.html: release-notes-1.8.md
- markdown $(srcdir)/release-notes-1.8.md > $(builddir)/release-notes-1.8.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/release-notes-1.8.md > $(builddir)/release-notes-1.8.html
include $(top_srcdir)/html.make
diff --git a/src/htdocs/releases/Makefile.am b/src/htdocs/releases/Makefile.am
index e3db97a0..17d17841 100644
--- a/src/htdocs/releases/Makefile.am
+++ b/src/htdocs/releases/Makefile.am
@@ -4,7 +4,7 @@ index.html: releases.html index.xml $(fullstyle) $(entities) $(page_style) $(pic
xsltproc @XSLTPROC_ARGS@ $(srcdir)/index.xml -o $@ --path "$(builddir)"
releases.html: releases.md
- markdown $(srcdir)/releases.md > $(builddir)/releases.html
+ cmark-gfm @CMARK_ARGS@ $(srcdir)/releases.md > $(builddir)/releases.html
SUBDIRS = \
1.24 \