diff options
author | Louie S <louie@example.com> | 2024-01-16 10:08:35 -0500 |
---|---|---|
committer | Louie S <louie@example.com> | 2024-01-16 10:08:35 -0500 |
commit | 1070d16a7c3027e7c05992a8f3ab01b11e2236cb (patch) | |
tree | d0c7d78311f35b3de19753d051779c15bc24cbd3 |
Added page about dash docsets
-rw-r--r-- | Makefile | 13 | ||||
-rw-r--r-- | dash-docset-contributions.html | 40 | ||||
-rw-r--r-- | dash-docset-contributions.md | 48 | ||||
-rw-r--r-- | index.html | 5 | ||||
-rw-r--r-- | index.md | 5 |
5 files changed, 111 insertions, 0 deletions
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..c12b344 --- /dev/null +++ b/Makefile @@ -0,0 +1,13 @@ +BASENAMES=$(basename $(wildcard *.md)) +SOURCES=$(foreach source,$(BASENAMES),$(source).md) +TARGETS=$(foreach target,$(BASENAMES),$(target).html) + +.PHONY: all +all: $(TARGETS) + +%.html: %.md + marked -o $@ $< + +.PHONY: clean +clean: + rm -f $(TARGETS) diff --git a/dash-docset-contributions.html b/dash-docset-contributions.html new file mode 100644 index 0000000..bb9038a --- /dev/null +++ b/dash-docset-contributions.html @@ -0,0 +1,40 @@ +<h2 id="dashzeal-docset-contributions"><a href="https://kapeli.com/dash">Dash</a>/<a href="https://zealdocs.org/">Zeal</a> Docset Contributions</h2> +<p>I package docsets for documentation generally unavailable through Dash/Zeal docsets.</p> +<p>My Dash docsets are based on a common <a href="https://github.com/lshprung/dash-docset-generation-template">generation template</a>. <br>Dash docsets maintained by me include:</p> +<ul> +<li><a href="https://github.com/lshprung/debmake-dash-docset">debmake</a> (<a href="https://salsa.debian.org/debian/debmake">upstream</a>)</li> +<li><a href="https://github.com/lshprung/flex-dash-docset">flex</a> (<a href="https://github.com/westes/flex">upstream</a>)</li> +<li><a href="https://github.com/lshprung/gnu-autoconf-dash-docset">GNU Autoconf</a> (<a href="https://www.gnu.org/software/autoconf/">upstream</a>)</li> +<li><a href="https://github.com/lshprung/gnu-autoconf-archive-dash-docset">GNU Autoconf Archive</a> (<a href="https://www.gnu.org/software/autoconf-archive/">upstream</a>) <strong>^</strong> </li> +<li><a href="https://github.com/lshprung/gnu-automake-dash-docset">GNU Automake</a> (<a href="https://www.gnu.org/software/automake/">upstream</a>)</li> +<li><a href="https://github.com/lshprung/gnu-bison-dash-docset">GNU Bison</a> (<a href="https://www.gnu.org/software/bison/">upstream</a>) <strong>^</strong></li> +<li><a href="https://github.com/lshprung/gnu-coding-standards-dash-docset">GNU Coding Standards</a> (<a href="https://savannah.gnu.org/projects/gnustandards">upstream</a>) *</li> +<li><a href="https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Guile">GNU Guile</a> 3+ (<a href="https://www.gnu.org/software/guile/">upstream</a>)</li> +<li><a href="https://github.com/lshprung/gnu-libtool-dash-docset">GNU Libtool</a> (<a href="https://www.gnu.org/software/libtool/">upstream</a>) *</li> +<li><a href="https://github.com/lshprung/meson-dash-docset">Meson</a> (<a href="https://mesonbuild.com/index.html">upstream</a>)</li> +<li><a href="https://github.com/lshprung/ncurses-dash-docset">ncurses</a> (<a href="https://invisible-island.net/ncurses/">upstream</a>)</li> +</ul> +<p>* indicates that the docset creation script could use improvement, usually in indexing index entries <br><strong>^</strong> indicates that a new version needs to be packaged, uploaded to the releases tab of the repo, and pushed to Dash-User-Contributions</p> +<p>I also have several unofficial Dash docsets that I maintain, but do not intend to contribute to <a href="https://github.com/Kapeli/Dash-User-Contributions">Dash-User-Contributions</a>, usually because my docset diverges from one that was already contributed or there is already an official version of the docset:</p> +<ul> +<li><a href="https://github.com/lshprung/gnu-bash-dash-docset">GNU Bash</a> (<a href="https://www.gnu.org/software/bash/">upstream</a>)</li> +<li><a href="https://github.com/lshprung/gnu-libc-dash-docset">GNU C Library (or "glibc")</a> (<a href="https://www.gnu.org/software/libc/libc.html">upstream</a>)</li> +</ul> +<p>Additional docsets I have desire to package in the future include:</p> +<ul> +<li>GNU Binutils (<a href="https://www.gnu.org/software/binutils/">upstream</a>)</li> +<li>GNU Coreutils (<a href="https://www.gnu.org/software/coreutils/">upstream</a>) <a href="https://github.com/lshprung/gnu-coreutils-dash-docset">WIP</a></li> +<li>GNU Grub (4 docsets) (<a href="https://www.gnu.org/software/grub/">upstream</a>) <a href="https://github.com/lshprung/gnu-grub-dash-docset">WIP</a></li> +<li>GNU Guix (<a href="https://guix.gnu.org/">upstream</a>)</li> +<li>GNU Texinfo (2 docsets) (<a href="https://www.gnu.org/software/texinfo/">upstream</a>) <a href="https://github.com/lshprung/gnu-texinfo-dash-docset">WIP</a></li> +<li>NSIS (<a href="https://nsis.sourceforge.io/">upstream</a>) <a href="https://github.com/lshprung/nsis-dash-docset">WIP</a></li> +</ul> +<p>"WIP" indicates that some working model exists, but has not yet been successfully pushed to Dash-User-Contributions</p> +<hr> +<h4 id="regarding-gnu-project-docsets">Regarding GNU project docsets</h4> +<p>It has been tiring to manage the high redundancy of the code in my various docset generation repos. This is especially true among GNU project docsets, and I believe it would be beneficial to contain all of these in a single repo. A few things to note:</p> +<ol> +<li>I would have to find a different solution to uploading compiled docsets, since I currently use the "releases" page of each repo. Github Pages, maybe?</li> +<li>There are certain edge cases in certain repos that may make things annoying. I would either have to account for these on a case by case basis or build a better infrastructure.</li> +</ol> +<p>For now, this remains an idea that I will need to brainstorm further...</p> diff --git a/dash-docset-contributions.md b/dash-docset-contributions.md new file mode 100644 index 0000000..6a19219 --- /dev/null +++ b/dash-docset-contributions.md @@ -0,0 +1,48 @@ +## [Dash](https://kapeli.com/dash)/[Zeal](https://zealdocs.org/) Docset Contributions + +I package docsets for documentation generally unavailable through Dash/Zeal docsets. + +My Dash docsets are based on a common [generation template](https://github.com/lshprung/dash-docset-generation-template). \ +Dash docsets maintained by me include: + +- [debmake](https://github.com/lshprung/debmake-dash-docset) ([upstream](https://salsa.debian.org/debian/debmake)) +- [flex](https://github.com/lshprung/flex-dash-docset) ([upstream](https://github.com/westes/flex)) +- [GNU Autoconf](https://github.com/lshprung/gnu-autoconf-dash-docset) ([upstream](https://www.gnu.org/software/autoconf/)) +- [GNU Autoconf Archive](https://github.com/lshprung/gnu-autoconf-archive-dash-docset) ([upstream](https://www.gnu.org/software/autoconf-archive/)) **^** +- [GNU Automake](https://github.com/lshprung/gnu-automake-dash-docset) ([upstream](https://www.gnu.org/software/automake/)) +- [GNU Bison](https://github.com/lshprung/gnu-bison-dash-docset) ([upstream](https://www.gnu.org/software/bison/)) **^** +- [GNU Coding Standards](https://github.com/lshprung/gnu-coding-standards-dash-docset) ([upstream](https://savannah.gnu.org/projects/gnustandards)) \* +- [GNU Guile](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/GNU_Guile) 3+ ([upstream](https://www.gnu.org/software/guile/)) +- [GNU Libtool](https://github.com/lshprung/gnu-libtool-dash-docset) ([upstream](https://www.gnu.org/software/libtool/)) \* +- [Meson](https://github.com/lshprung/meson-dash-docset) ([upstream](https://mesonbuild.com/index.html)) +- [ncurses](https://github.com/lshprung/ncurses-dash-docset) ([upstream](https://invisible-island.net/ncurses/)) + +\* indicates that the docset creation script could use improvement, usually in indexing index entries \ +**^** indicates that a new version needs to be packaged, uploaded to the releases tab of the repo, and pushed to Dash-User-Contributions + +I also have several unofficial Dash docsets that I maintain, but do not intend to contribute to [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions), usually because my docset diverges from one that was already contributed or there is already an official version of the docset: + +- [GNU Bash](https://github.com/lshprung/gnu-bash-dash-docset) ([upstream](https://www.gnu.org/software/bash/)) +- [GNU C Library (or "glibc")](https://github.com/lshprung/gnu-libc-dash-docset) ([upstream](https://www.gnu.org/software/libc/libc.html)) + +Additional docsets I have desire to package in the future include: + +- GNU Binutils ([upstream](https://www.gnu.org/software/binutils/)) +- GNU Coreutils ([upstream](https://www.gnu.org/software/coreutils/)) [WIP](https://github.com/lshprung/gnu-coreutils-dash-docset) +- GNU Grub (4 docsets) ([upstream](https://www.gnu.org/software/grub/)) [WIP](https://github.com/lshprung/gnu-grub-dash-docset) +- GNU Guix ([upstream](https://guix.gnu.org/)) +- GNU Texinfo (2 docsets) ([upstream](https://www.gnu.org/software/texinfo/)) [WIP](https://github.com/lshprung/gnu-texinfo-dash-docset) +- NSIS ([upstream](https://nsis.sourceforge.io/)) [WIP](https://github.com/lshprung/nsis-dash-docset) + +"WIP" indicates that some working model exists, but has not yet been successfully pushed to Dash-User-Contributions + +--- + +#### Regarding GNU project docsets + +It has been tiring to manage the high redundancy of the code in my various docset generation repos. This is especially true among GNU project docsets, and I believe it would be beneficial to contain all of these in a single repo. A few things to note: + +1. I would have to find a different solution to uploading compiled docsets, since I currently use the "releases" page of each repo. +2. There are certain edge cases in certain repos that may make things annoying. I would either have to account for these on a case by case basis or build a better infrastructure. + +For now, this remains an idea that I will need to brainstorm further... diff --git a/index.html b/index.html new file mode 100644 index 0000000..61706a6 --- /dev/null +++ b/index.html @@ -0,0 +1,5 @@ +<h1 id="lshprunggithubio">lshprung.github.io</h1> +<h3 id="pages">Pages</h3> +<ul> +<li><a href="dash-docset-contributions.html">Dash Docset Contributions</a></li> +</ul> diff --git a/index.md b/index.md new file mode 100644 index 0000000..49175e4 --- /dev/null +++ b/index.md @@ -0,0 +1,5 @@ +# lshprung.github.io + +### Pages + +- [Dash Docset Contributions](dash-docset-contributions.html) |