aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2024-09-17 16:31:59 +0200
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2024-09-17 16:31:59 +0200
commitca0d5e087e10a50decc913c3f55dc744774c764e (patch)
treec3bb44df80670becac8c63a34b5d2865575c27d4
parent3db9368a2619ae3bdb4afbc6f72625de6f01208a (diff)
downloadsciteco-ca0d5e087e10a50decc913c3f55dc744774c764e.tar.gz
Github pages are auto-generated from the Markdown files and HTML manuals now
* This pushes to the gh-pages branch since we don't yet want to introduce a new workflow (that would have to rebuild SciTECO). * Built as part of the nightly MacOS builds. The Ubuntu builds directly build Debian packages which do not contain the HTML manuals. * I don't want to check in images into the master branch. The gh-pages branch is cleaned with every build. Therefore I still cross-link to Sourceforge for any additional images and documents. * We could automatically build the cheat-sheet.pdf (TODO?). For the time being, we are still linking to Sourceforge.
-rw-r--r--.github/workflows/nightly.yml25
-rw-r--r--README26
-rw-r--r--screenshots.md5
-rwxr-xr-xwww/build.tes114
4 files changed, 156 insertions, 14 deletions
diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml
index 2e438ef..a689f99 100644
--- a/.github/workflows/nightly.yml
+++ b/.github/workflows/nightly.yml
@@ -112,7 +112,7 @@ jobs:
# but the more we get rid off, the better.
run: |
autoreconf -i
- ./configure --with-interface=ncurses --enable-static-executables
+ ./configure --with-interface=ncurses --enable-static-executables --enable-html-manual
- name: make
run: make -j 2
@@ -145,6 +145,29 @@ jobs:
tag: nightly
files: ./*.pkg
+ # The website is published on Mac OS only because we cannot tweak the
+ # ./configure flags on Ubuntu where Debian packages are built.
+ # FIXME: This could be done without a gh-pages branch, see
+ # https://github.com/actions/starter-workflows/blob/main/pages/static.yml
+ # This however should be in its own workflow and we'd have to rebuild
+ # SciTECO and everything.
+ - run: make install
+ - name: Install lowdown (Markdown processor)
+ run: brew install lowdown
+ - name: Generate website
+ run: cd www && sciteco -m build.tes
+ - name: Publish Website
+ run: |
+ cd www
+ touch .nojekyll
+ git init
+ cp ../.git/config ./.git/config
+ git add .nojekyll *.html
+ git config --local user.email "Website@GitHubActions"
+ git config --local user.name "GitHub Actions"
+ git commit -a -m "update ${{ github.sha }}"
+ git push -u origin +HEAD:gh-pages
+
win32-curses:
runs-on: windows-2019
diff --git a/README b/README
index 2361f5c..580e332 100644
--- a/README
+++ b/README
@@ -16,10 +16,10 @@ as far as possible. For instance, moving the cursor to the right can be done imm
When you delete a character from the end of the command line macro (called rubout), the
side-effects of that character which may be a command or part of a command, are undone.
-![SciTECO demo](https://sciteco.sourceforge.net/graphics/sciteco-ncurses.gif)
+![SciTECO demo](https://sciteco.sf.net/graphics/sciteco-ncurses.gif)
-SciTECO uses the [Scintilla](http://www.scintilla.org/) editor component and supports
-GTK+ 3 as well as Curses frontends (using [Scinterm](http://foicica.com/scinterm/)).
+SciTECO uses the [Scintilla](https://www.scintilla.org/) editor component and supports
+GTK+ 3 as well as Curses frontends (using [Scinterm](https://foicica.com/scinterm/)).
The Curses frontend is verified to work with [ncurses](https://www.gnu.org/software/ncurses/),
[NetBSD Curses](https://github.com/sabotage-linux/netbsd-curses),
@@ -111,8 +111,8 @@ Download
There are prebuilt binary packages and source bundles for your convenience:
-* [Download Archive at Sourceforge](https://sourceforge.net/projects/sciteco/files/)
* [Github Releases](https://github.com/rhaberkorn/sciteco/releases)
+* [Download Archive at Sourceforge](https://sourceforge.net/projects/sciteco/files/)
* [Ubuntu PPA](https://launchpad.net/~robin-haberkorn/+archive/sciteco)
* [Arch User Repository](https://aur.archlinux.org/packages/sciteco-git)
* Users of OpenWrt may try to install the
@@ -131,20 +131,20 @@ For [Mac OS X](https://github.com/rhaberkorn/sciteco/wiki/Mac-OS-Support),
we currently only provide *experimental* ncurses builds.
If everything fails, you can try building from source.
-See [`INSTALL`](INSTALL) for more details.
+See [`INSTALL`](https://github.com/rhaberkorn/sciteco/blob/master/INSTALL) for more details.
Additional Documentation
========================
* Online manpages:
- [__sciteco__(1)](http://sciteco.sf.net/manuals/sciteco.1.html),
- [__sciteco__(7)](http://sciteco.sf.net/manuals/sciteco.7.html),
- [__grosciteco.tes__(1)](http://sciteco.sf.net/manuals/grosciteco.tes.1.html),
- [__tedoc.tes__(1)](http://sciteco.sf.net/manuals/tedoc.tes.1.html)
-* [Cheat Sheet and Language Overview](http://sciteco.sf.net/manuals/cheat-sheet.pdf).
+ [__sciteco__(1)](https://rhaberkorn.github.io/sciteco/sciteco.1.html),
+ [__sciteco__(7)](https://rhaberkorn.github.io/sciteco/sciteco.7.html),
+ [__grosciteco.tes__(1)](https://rhaberkorn.github.io/sciteco/grosciteco.tes.1.html),
+ [__tedoc.tes__(1)](https://rhaberkorn.github.io/sciteco/tedoc.tes.1.html)
+* [Cheat Sheet and Language Overview](https://sciteco.sf.net/manuals/cheat-sheet.pdf).
This can be printed on an A4 sheet of paper.
* [Wiki at Github](https://github.com/rhaberkorn/sciteco/wiki)
-* A [short presentation](http://sciteco.sf.net/manuals/presentation.pdf)
- (in German!) hold at [Netz39](http://www.netz39.de/).
+* A [short presentation](https://sciteco.sf.net/manuals/presentation.pdf)
+ (in German!) hold at [Netz39](https://www.netz39.de/).
-<p align="center"><img alt="SciTECO icon" src="ico/sciteco-48.png"/></p>
+<p align="center"><img alt="SciTECO icon" src="https://github.com/rhaberkorn/sciteco/raw/master/ico/sciteco-48.png"/></p>
diff --git a/screenshots.md b/screenshots.md
new file mode 100644
index 0000000..fe7e7a9
--- /dev/null
+++ b/screenshots.md
@@ -0,0 +1,5 @@
+# Screenshots
+
+## v2.1 (dev)
+
+![Screenshot](https://sciteco.sf.net/graphics/sciteco-ncurses.gif)
diff --git a/www/build.tes b/www/build.tes
new file mode 100755
index 0000000..1c96608
--- /dev/null
+++ b/www/build.tes
@@ -0,0 +1,114 @@
+#!/usr/local/bin/sciteco -m
+!*
+ * Generate the website at https://rhaberkorn.github.io/sciteco
+ * This reuses content from Markdown documents and the manpages.
+ * Everything else is cross-linked to Sourceforge.
+ * It must currently be run from the www/ subdirectory of an in-tree-build.
+ * The HTML manuals must be in ../doc.
+ * Required tools: lowdown
+ *!
+
+!*
+ * Perhaps everything should be white on black, like in a terminal?
+ * The first line could be inverted (black on white).
+ *!
+@[header]{I
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+ <title>SciTECO - &lt;Website&gt; Q[title]</title>
+ <style>
+ @import "https://www.nerdfonts.com/assets/css/webfont.css";
+
+ .reverse {
+ background-color: black;
+ color: white;
+ }
+
+ /* For grohtml-generated content */
+ .grohtml p { margin-top: 0; margin-bottom: 0; vertical-align: top }
+ .grohtml pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
+ .grohtml table { margin-top: 0; margin-bottom: 0; vertical-align: top }
+ .grohtml h1 { text-align: center }
+ </style>
+</head>
+<body>
+<tt>
+ SciTECO - &lt;Website&gt;
+ <span class="nf nf-md-home"></span> <a href="index.html">Home</a> /
+ <span class="nf nf-md-image"></span> <a href="screenshots.html">Screenshots</a> /
+ <span class="nf nf-md-floppy_variant"></span> <a href="https://github.com/rhaberkorn/sciteco/releases" target=_blank>Downloads</a> /
+ <span class="nf nf-fa-book_atlas"></span> <a href="sciteco.1.html"><b>sciteco</b>(1)</a> /
+ <span class="nf nf-fa-book_bible"></span> <a href="sciteco.7.html"><b>sciteco</b>(7)</a> /
+ <span class="nf nf-md-alpha_w_box"></span> <a href="https://github.com/rhaberkorn/sciteco/wiki" target=_blank>Wiki</a> /
+ <span class="nf nf-fa-github_square"></span> <a href="https://github.com/rhaberkorn/sciteco" target=_blank>Github</a>
+</tt>
+<hr>
+}
+
+!* This is a macro, so we can potentially customize the content per page *!
+@[footer]{I
+<hr>
+<tt>
+<table width="100%"><tr>
+ <td width="1ch" valign=top><b>*</b></td>
+ <td valign=top><marquee>IThis page was made with SciTECO.<span class=reverse>$</span>-EX<span class=reverse>$$</span></marquee></td>
+ <td width=56><a href="https://github.com/rhaberkorn/sciteco/issues" target=_blank>
+ <img src="https://sciteco.sf.net/graphics/notbug.gif" title="There are no bugs. Go away.">
+ </a></td>
+</tr></table>
+</tt>
+</body>
+</html>
+}
+
+EBindex.html HK
+ [title]Home M[header]
+ EClowdown -thtml --html-no-skiphtml --html-no-escapehtml ../README.md
+ M[footer]
+EW
+
+EBscreenshots.html HK
+ [title]Screenshots M[header]
+ EClowdown -thtml --html-no-skiphtml --html-no-escapehtml ../screenshots.md
+ M[footer]
+EW
+
+[manpage-header]
+ <p class="nf nf-fa-warning"> This documents the project's HEAD revision.</p>
+ <div class="grohtml">
+
+EB../doc/sciteco.1.html
+ S<body>S<h1  L 0,.K
+ [title]sciteco(1) M[header] G[manpage-header]
+ FD<hr>S</body> .,ZK
+ M[footer]
+EWsciteco.1.html
+
+EB../doc/sciteco.7.html
+ S<body>S<h1  L 0,.K
+ [title]sciteco(7) M[header] G[manpage-header]
+ FD<hr>S</body> .,ZK
+ M[footer]
+EWsciteco.7.html
+
+!*
+ * These manpages are not in the header bar, but still postprocessed
+ * for consinstency.
+ *!
+
+EB../doc/grosciteco.tes.1.html
+ S<body>S<h1  L 0,.K
+ [title]grosciteco.tes(1) M[header] G[manpage-header]
+ FD<hr>S</body> .,ZK
+ M[footer]
+EWgrosciteco.tes.1.html
+
+EB../doc/tedoc.tes.1.html
+ S<body>S<h1  L 0,.K
+ [title]tedoc.tes(1) M[header] G[manpage-header]
+ FD<hr>S</body> .,ZK
+ M[footer]
+EWtedoc.tes.1.html
+
+EX