Skip to contentSkip to conversation

New package: lowdown - a markdown translator

PATCH In review Joachim Wiberg 2 participants 3 messages Jan 7, 2025 – Mar 22, 2025

lore
Share & tools
lore
#0 lore raw

cover New package: lowdown - a markdown translator

Hi everyone!

Here's a neat little markdown translator we've been using in our project to provide online CLI help texts from our GitHub markdown documentation in products we ship.

It supports many features and extensions, e.g., footnotes, tables, and fenced code blocks. For more info, see https://kristaps.bsd.lv/lowdown/

For terminal viewing you need UTF8, and the 'less' program in BusyBox seems a bit broken right now, but 'more' or the big less package can be used to render very readable text:

lowdown -tterm foo.md | more

I was a bit unsure of which section it would fit best in, so please let me know if that needs changing.

The program has no external dependencies, yet resisted all my attempts at trying to build a static version of it, hence !BR2_STATIC_LIBS. It is not autotools based, despite the configure script (it's ocoonfigure).

Best regards
/Joachim

Joachim Wiberg (1):
package/lowdown: new package

 DEVELOPERS                   |  1 +
 package/Config.in            |  1 +
 package/lowdown/Config.in    | 14 ++++++++++++++
 package/lowdown/lowdown.hash |  5 +++++
 package/lowdown/lowdown.mk   | 24 ++++++++++++++++++++++++
 5 files changed, 45 insertions(+)
 create mode 100644 package/lowdown/Config.in
 create mode 100644 package/lowdown/lowdown.hash
 create mode 100644 package/lowdown/lowdown.mk
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot
#1 lore raw

PATCH 1/1 package/lowdown: new package

---
 DEVELOPERS                   |  1 +
 package/Config.in            |  1 +
 package/lowdown/Config.in    | 14 ++++++++++++++
 package/lowdown/lowdown.hash |  5 +++++
 package/lowdown/lowdown.mk   | 24 ++++++++++++++++++++++++
 5 files changed, 45 insertions(+)
 create mode 100644 package/lowdown/Config.in
 create mode 100644 package/lowdown/lowdown.hash
 create mode 100644 package/lowdown/lowdown.mk
DEVELOPERS +1 -0
index 16b72eee08..39b9aa4ea3 100644
@@ -1615,6 +1615,7 @@ F:	package/libite/
 F:	package/libnet/
 F:	package/libteam/
 F:	package/libuev/
+F:	package/lowdown/
 F:	package/mg/
 F:	package/mdnsd/
 F:	package/mini-snmpd/
package/Config.in +1 -0
index 400183516e..58a04efc96 100644
@@ -2765,6 +2765,7 @@ comment "Utilities"
 	source "package/lockfile-progs/Config.in"
 	source "package/logrotate/Config.in"
 	source "package/logsurfer/Config.in"
+	source "package/lowdown/Config.in"
 	source "package/minisign/Config.in"
 	source "package/neofetch/Config.in"
 	source "package/pdmenu/Config.in"
package/lowdown/Config.in new file +14 -0
new file mode 100644
index 0000000000..00ae6fcce6
@@ -0,0 +1,14 @@
+config BR2_PACKAGE_LOWDOWN
+	bool "lowdown"
+	depends on BR2_USE_WCHAR
+	depends on !BR2_STATIC_LIBS
+	help
+	  Simple markdown translator to HTML5, terminal, and more.
+	  Useful for providing the same help texts both for a CLI
+	  and web.
+
+	  https://kristaps.bsd.lv/lowdown/
+
+comment "lowdown needs a toolchain w/ wchar and shared library support"
+	depends on BR2_USE_WCHAR
+	depends on !BR2_STATIC_LIBS
package/lowdown/lowdown.hash new file +5 -0
new file mode 100644
index 0000000000..0b4d1fd25d
@@ -0,0 +1,5 @@
+# SHA512 from release archive https://kristaps.bsd.lv/lowdown/snapshots/
+sha512  316b27384f83cb57fa414c315556fd177f2998c009e031986446e82252f276dc68adfeb263b88640deccb7084da4771d0ee8fae7d37388dba4e1a0aa426c701d  lowdown-1.4.0.tar.gz
+
+# Locally calculated
+sha256  204658eb0d5ba87935056630534cdafd21ed29597e0a9c9f8f557779a3fb99d4  LICENSE.md
package/lowdown/lowdown.mk new file +24 -0
new file mode 100644
index 0000000000..d88b70327a
@@ -0,0 +1,24 @@
+################################################################################
+#
+# lowdown
+#
+################################################################################
+
+LOWDOWN_VERSION = 1.4.0
+LOWDOWN_SITE = https://kristaps.bsd.lv/lowdown/snapshots
+LOWDOWN_LICENSE = ISC
+LOWDOWN_LICENSE_FILES = LICENSE.md
+
+define LOWDOWN_CONFIGURE_CMDS
+	(cd $(@D); $(TARGET_CONFIGURE_OPTS) ./configure)
+endef
+
+define LOWDOWN_BUILD_CMDS
+	$(TARGET_MAKE_ENV) $(MAKE) -C $(@D)
+endef
+
+define LOWDOWN_INSTALL_TARGET_CMDS
+	$(INSTALL) -t $(TARGET_DIR)/usr/bin -D -m 0755 $(@D)/lowdown
+endef
+
+$(eval $(generic-package))
Signature · 6 lines
2.43.0

_______________________________________________
buildroot mailing list
[email protected]
https://lists.buildroot.org/mailman/listinfo/buildroot