List for cgit developers and users
 help / color / mirror / Atom feed
From: Pedro Lucas Porcellis <porcellis@eletrotupi.com>
To: cgit@lists.zx2c4.com
Cc: Pedro Lucas Porcellis <porcellis@eletrotupi.com>
Subject: [PATCH] Add "How to display about page?" info
Date: Sun, 27 Sep 2020 23:28:33 -0300
Message-ID: <20200928022833.31966-1-porcellis@eletrotupi.com> (raw)

Also added some info regarding the about pages + dir scan and on filters
having different locations from distro to distro.
---
 faq | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/faq b/faq
index e940510..6d31781 100644
--- a/faq
+++ b/faq
@@ -39,3 +39,28 @@ You can use a post-receive hook to run a script that tells CGit the
 correct modification time by writing to ``info/web/last-modified``.  An
 example is provided in the CGit repository at
 ``contrib/hooks/post-receive.agefile``.
+
+### How to display the `about` page?
+
+In order to display the about page by repository, you just need to define what
+files cgit must look after on your `cgitrc (5)` file.
+
+```sh
+readme=:README.md
+readme=:README.rst
+# ...
+```
+
+To enable the markdown parsing, add the included conversion script (converts
+from markdown, rst, txt to html).
+
+`about-filter=/usr/lib/cgit/filters/about-formatting.sh`
+
+_Note that the location may slightly change by distros, for instance on Alpine
+Linux it's located on `/usr/lib/cgit/filters`. It's recommended to check on
+your package manager where it's being installed._
+
+## My configuration is not being loaded for my scan directory
+
+The scan directory should be after those lines. Matter of fact, it's
+recommended to be the last line on your `cgitrc` file.
-- 
2.28.0


                 reply	other threads:[~2020-09-28  2:37 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200928022833.31966-1-porcellis@eletrotupi.com \
    --to=porcellis@eletrotupi.com \
    --cc=cgit@lists.zx2c4.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

List for cgit developers and users

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.vuxu.org/cgit

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 cgit cgit/ http://inbox.vuxu.org/cgit \
		cgit@lists.zx2c4.com
	public-inbox-index cgit

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.archive.cgit


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git