shtmlview_mkdoc(3tk)

💖 shtmlview_mkdoc — the glow-up your viewer needed 💖

okay bestie, so this page is shtmlview_mkdoc(3tk) — yes, section 3tk, the Tk corner of the manual universe — and it's here to tell you about a lil extension package that makes your HTML viewer understand mkdoc markup. that's it, that's the whole vibe. let's get into it 🦋

---

✨ NAME ✨

shtmlview_mkdoc — it's an shtmlview extension, and what it does is add support for mkdoc markup. lowkey iconic.

---

🌸 SYNOPSIS 🌸

package require mkdoc::mkdoc

package require shtmlview::shtmlview

that's the whole thing. two package require lines and you're in business 💅

---

🎀 DESCRIPTION 🎀

so the shtmlview::mkdoc package extends shtmlview::shtmlview widgets, right? and the whole point is that it gives them support for rendering mkdoc-formatted documents. mkdoc in, pretty document out. no cap.

here's the part that's giving main character energy: simply loading the package registers the support. that's it. that's the entire installation ritual. no setup function, no init call, nothing. you package require it and the capability is just there, like a bestie who shows up with boba unannounced 🧋

and also — the package does not export any kind of command, class, etc. zero exports. none. it's not a package you call, it's a package you have. the way that it does literally nothing except exist and make your widget smarter?? obsessed.

---

⭐ CHANGELOG ⭐

• 2022-04-07, version 0.1
  • Initial implementation ✨ (the origin story, the debut, the first post)

---

💀 BUGS, IDEAS, FEEDBACK 💀

ngl, this document — and the package it describes — will undoubtedly contain bugs and other problems. shocking, i know, a piece of software with bugs 😭

please report such to the author of this package. and also please report any ideas for enhancements you may have for either the package and/or the documentation — they want to hear it, fr fr. feedback is a love language 🫶

---

👑 CODE COPYRIGHT 👑

BSD License type:

Sun Microsystems, Inc. The following terms apply to all files associated with the software unless explicitly disclaimed in individual files.

The authors hereby grant permission to use, copy, modify, distribute, and license this software and its documentation for any purpose, provided that existing copyright notices are retained in all copies and that this notice is included verbatim in any distributions. No written agreement, license, or royalty fee is required for any of the authorized uses. Modifications to this software may be copyrighted by their authors and need not follow the licensing terms described here, provided that the new terms are clearly indicated on the first page of each file where they apply.

In no event shall the authors or distributors be liable to any party for direct, indirect, special, incidental, or consequential damages arising out of the use of this software, its documentation, or any derivatives thereof, even if the authors have been advised of the possibility of such damage.

The authors and distributors specifically disclaim any warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. This software is provided on an "as is" basis, and the authors and distributors have no obligation to provide maintenance, support, updates, enhancements, or modifications.

RESTRICTED RIGHTS: Use, duplication or disclosure by the government is subject to the restrictions as set forth in subparagraph (c) (1) (ii) of the Rights in Technical Data and Computer Software Clause as DFARS 252.227-7013 and FAR 52.227-19.

okay so that's a lot of legal words but the important bits: it's BSD-licensed, keep the notices, and it comes with no warranty whatsoever — "as is" basis, no promises, no maintenance obligations. read it, respect it, move on 💜

---

🌈 SEE ALSO 🌈

• mkdoc
• shtmlview

go read those too, bestie, they're the supporting cast 🎬

---

🍓 KEYWORDS 🍓

html, mkdoc

---

💜 COPYRIGHT 💜

Copyright (c) 2022, Detlef Groth <detlef(at)dgroth(dot)de>

---

and that's the whole page!! 💅 this one ships as part of tklib, version 0.1, and the changelog moment was 2022-04-07 — so yeah, lil baby package, born in the spring, already slaying. 🎀✨ bye bestie, go render something pretty 🦋