From 64aa954d32136d87555dd236b5e9d6241c34ca19 Mon Sep 17 00:00:00 2001 From: pho4cexa Date: Wed, 1 Feb 2023 16:24:28 -0800 Subject: [PATCH] move issues into ISSUES/ ; shorten readme --- ISSUES/0002.txt | 3 + ISSUES/0003 | 3 + ISSUES/an issue in filename only :debug | 0 ISSUES/branches and releases (tags) :feature | 0 ...readme, license, and issues behaviors :doc | 0 ISSUES/diffs for each commit :feature | 0 ...tyle syntax highlight code blocks :feature | 0 ...f-contents mechanism for markdown :feature | 2 + ISSUES/line numbers :feature | 0 ISSUES/move all TODOs into ISSUES :doc | 0 ...-page or collapse-able files list :feature | 0 .../other mechanisms for header id :feature | 1 + ISSUES/presenter for binary files :feature | 2 + ...provide a precompiled binary download :doc | 0 .../render git log text as markdown :feature | 0 ...s as forks with divergence status :feature | 0 ISSUES/syntax highlighting :feature | 0 ... post-update rather than post-receive hook | 0 ...-update rather than post-receive hook :doc | 0 README.md | 79 ++++--------------- 20 files changed, 27 insertions(+), 63 deletions(-) create mode 100644 ISSUES/0002.txt create mode 100644 ISSUES/0003 create mode 100644 ISSUES/an issue in filename only :debug create mode 100644 ISSUES/branches and releases (tags) :feature create mode 100644 ISSUES/describe readme, license, and issues behaviors :doc create mode 100644 ISSUES/diffs for each commit :feature create mode 100644 ISSUES/gfm style syntax highlight code blocks :feature create mode 100644 ISSUES/implement table-of-contents mechanism for markdown :feature create mode 100644 ISSUES/line numbers :feature create mode 100644 ISSUES/move all TODOs into ISSUES :doc create mode 100644 ISSUES/mult-page or collapse-able files list :feature create mode 100644 ISSUES/other mechanisms for header id :feature create mode 100644 ISSUES/presenter for binary files :feature create mode 100644 ISSUES/provide a precompiled binary download :doc create mode 100644 ISSUES/render git log text as markdown :feature create mode 100644 ISSUES/show remotes as forks with divergence status :feature create mode 100644 ISSUES/syntax highlighting :feature create mode 100644 ISSUES/use post-update rather than post-receive hook create mode 100644 ISSUES/use post-update rather than post-receive hook :doc diff --git a/ISSUES/0002.txt b/ISSUES/0002.txt new file mode 100644 index 0000000..79a2c0f --- /dev/null +++ b/ISSUES/0002.txt @@ -0,0 +1,3 @@ +A plain text file issue + +with a short description diff --git a/ISSUES/0003 b/ISSUES/0003 new file mode 100644 index 0000000..6239067 --- /dev/null +++ b/ISSUES/0003 @@ -0,0 +1,3 @@ +Another plain text file issue with no extension + +and a short description diff --git a/ISSUES/an issue in filename only :debug b/ISSUES/an issue in filename only :debug new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/branches and releases (tags) :feature b/ISSUES/branches and releases (tags) :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/describe readme, license, and issues behaviors :doc b/ISSUES/describe readme, license, and issues behaviors :doc new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/diffs for each commit :feature b/ISSUES/diffs for each commit :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/gfm style syntax highlight code blocks :feature b/ISSUES/gfm style syntax highlight code blocks :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/implement table-of-contents mechanism for markdown :feature b/ISSUES/implement table-of-contents mechanism for markdown :feature new file mode 100644 index 0000000..710dec2 --- /dev/null +++ b/ISSUES/implement table-of-contents mechanism for markdown :feature @@ -0,0 +1,2 @@ +because I don't usebecause i don't use m455's vim-markdown-toc plugin and they get out-of-sync + diff --git a/ISSUES/line numbers :feature b/ISSUES/line numbers :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/move all TODOs into ISSUES :doc b/ISSUES/move all TODOs into ISSUES :doc new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/mult-page or collapse-able files list :feature b/ISSUES/mult-page or collapse-able files list :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/other mechanisms for header id :feature b/ISSUES/other mechanisms for header id :feature new file mode 100644 index 0000000..633b6e1 --- /dev/null +++ b/ISSUES/other mechanisms for header id :feature @@ -0,0 +1 @@ +like uniqueness checking, sequential numbering diff --git a/ISSUES/presenter for binary files :feature b/ISSUES/presenter for binary files :feature new file mode 100644 index 0000000..e05022f --- /dev/null +++ b/ISSUES/presenter for binary files :feature @@ -0,0 +1,2 @@ +display binary files as output from binary-file analysis tools + like `hexdump`, `xxd`, `dumpelf`, `elfls`, `readelf`, etc.? diff --git a/ISSUES/provide a precompiled binary download :doc b/ISSUES/provide a precompiled binary download :doc new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/render git log text as markdown :feature b/ISSUES/render git log text as markdown :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/show remotes as forks with divergence status :feature b/ISSUES/show remotes as forks with divergence status :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/syntax highlighting :feature b/ISSUES/syntax highlighting :feature new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/use post-update rather than post-receive hook b/ISSUES/use post-update rather than post-receive hook new file mode 100644 index 0000000..e69de29 diff --git a/ISSUES/use post-update rather than post-receive hook :doc b/ISSUES/use post-update rather than post-receive hook :doc new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index b83a40a..572e6d8 100644 --- a/README.md +++ b/README.md @@ -101,22 +101,22 @@ specified directory, where your `default.html` template lives. The following variables are available to templates: -- source_files_list: a list of all the files in the repo. -- repository_description: a short description of the repo, if provided. See configuration. -- repository_name: the name of the repo. See configuration. -- repository_path: the URL path from the forge root to the repo. -- repository_path_parent: repository_path without the repo itself. -- repository_ancestors: a list of each path element in repository_path_parent -- readme_file: the filename of the README file, if any. used for the "about" link. -- license_file: the filename of the LICENSE file, if any. used for the "license" link. -- issues_file: if any files exist in ISSUES/, this will be set to "ISSUES". -- repo2html_version: the blob hash of main.scm in this repository. -- source_file: the filename of the file being rendered. -- root: always "" (TODO: omit this?) -- elements: a list of each path element leading to the file being rendered -- basename: the filename being rendered, with one extension removed -- extension: the extension removed in basename -- relative_root: "html/" if the current file is "/index.html" otherwise "" +- `source_files_list`: a list of all the files in the repo. +- `repository_description`: a short description of the repo, if provided. See configuration. +- `repository_name`: the name of the repo. See configuration. +- `repository_path`: the URL path from the forge root to the repo. +- `repository_path_parent`: repository_path without the repo itself. +- `repository_ancestors`: a list of each path element in repository_path_parent. +- `readme_file`: the filename of the README file, if any. used for the "about" link. +- `license_file`: the filename of the LICENSE file, if any. used for the "license" link. +- `issues_file`: if any files exist in ISSUES/, this will be set to "ISSUES". +- `repo2html_version`: the blob hash of main.scm in this repository. +- `source_file`: the filename of the file being rendered. +- `root`: always empty. # TODO FIXME +- `elements`: a list of each path element leading to the file being rendered. +- `basename`: the filename being rendered, with one extension removed. +- `extension`: the extension removed in basename. +- `relative_root`: `html/` if the current file is `/index.html` otherwise empty. ## Configuration @@ -197,50 +197,3 @@ Other tools like `repo2html`, that generate a set of HTML files representing the - [stagit](https://codemadness.org/git/stagit/file/README.html) - [depp](https://git.8pit.net/depp.git/) - [git-arr](https://blitiri.com.ar/p/git-arr/) - -### Git Forge Software - -Software for self-hosting or building your own collection of many git repos for potentially multiple users. - -- [GitLab](https://about.gitlab.com/install/) -- [Gogs](https://gogs.io/) -- [Gitea](https://gitea.io/) -- [cgit](https://git.zx2c4.com/cgit/) -- [GitWeb](https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb) -- [legit](https://git.icyphox.sh/legit) -- [gitile](https://git.lepiller.eu/gitile) -- [pagure](https://pagure.io/pagure) - -### Git Forge Services - -Third-party-hosted services that will host browsable code repositories. - -- [NotABug](https://notabug.org/) -- [Codeberg](https://codeberg.org/) -- [sourcehut](https://sourcehut.org/) -- [GitLab](https://gitlab.com/) -- [SourceForge](https://sourceforge.net/) -- Red Hat [pagure](https://pagure.io/pagure) -- Atlassian Bitbucket -- Microsoft GitHub - -## Todos - -- **documentation**: move all of these TODOs into ISSUES/ -- **documentation**: provide a precompiled binary download -- **documentation/feature**: use post-update rather than post-receive hook for - simplicity -- **documentation**: also describe use with post-commit hook -- **documentation**: describe readme, license, and issues behaviours -- **feature**: multi-page or collapse-able files list -- **feature**: branches and releases (tags) -- **feature**: diffs for each commit -- **feature**: clickable line numbers in source files -- **feature**: display binary files as output from binary-file analysis tools - like `hexdump`, `xxd`, `dumpelf`, `elfls`, `readelf`, etc.? -- **feature**: syntax highlighting? -- **feature**: markdown-render git log text -- **feature**: other mechanisms for header id application like uniqueness - checking, sequential numbering -- **feature**: remotes, upstream identification, and tracking branch status -- **feature**: reimplement a table-of-contents mechanism because i don't use m455's vim-markdown-toc plugin and they get out-of-sync