From ca0d5e087e10a50decc913c3f55dc744774c764e Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Tue, 17 Sep 2024 16:31:59 +0200 Subject: 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. --- .github/workflows/nightly.yml | 25 ++++++++- README | 26 +++++----- screenshots.md | 5 ++ www/build.tes | 114 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 156 insertions(+), 14 deletions(-) create mode 100644 screenshots.md create mode 100755 www/build.tes 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/). -

SciTECO icon

+

SciTECO icon

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 + + + + SciTECO - <Website> Q[title] + + + + + SciTECO - <Website> + Home / + Screenshots / + Downloads / + sciteco(1) / + sciteco(7) / + Wiki / + Github + +
+} + +!* This is a macro, so we can potentially customize the content per page *! +@[footer]{I +
+ + + + + +
*IThis page was made with SciTECO.$-EX$$ + +
+ + + +} + +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] +

This documents the project's HEAD revision.

+
 + +EB../doc/sciteco.1.html + SS

S .,ZK + M[footer] +EWsciteco.1.html + +EB../doc/sciteco.7.html + SS

S .,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 + SS

S .,ZK + M[footer] +EWgrosciteco.tes.1.html + +EB../doc/tedoc.tes.1.html + SS

S .,ZK + M[footer] +EWtedoc.tes.1.html + +EX -- cgit v1.2.3