List for cgit developers and users
 help / color / mirror / Atom feed
* [PATCH] Add "How to display about page?" info
@ 2020-09-28  2:28 Pedro Lucas Porcellis
  0 siblings, 0 replies; only message in thread
From: Pedro Lucas Porcellis @ 2020-09-28  2:28 UTC (permalink / raw)
  To: cgit; +Cc: Pedro Lucas Porcellis

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


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2020-09-28  2:37 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-09-28  2:28 [PATCH] Add "How to display about page?" info Pedro Lucas Porcellis

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