From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=-1.1 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE autolearn=ham autolearn_force=no version=3.4.4 Received: (qmail 31827 invoked from network); 28 Sep 2020 02:37:30 -0000 Received: from krantz.zx2c4.com (192.95.5.69) by inbox.vuxu.org with ESMTPUTF8; 28 Sep 2020 02:37:30 -0000 Received: by krantz.zx2c4.com (ZX2C4 Mail Server) with ESMTP id 5e03b226; Mon, 28 Sep 2020 02:06:05 +0000 (UTC) Return-Path: Received: from out0.migadu.com (out0.migadu.com [94.23.1.103]) by krantz.zx2c4.com (ZX2C4 Mail Server) with ESMTPS id f1bb1f6c (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256:NO) for ; Mon, 28 Sep 2020 02:06:03 +0000 (UTC) X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eletrotupi.com; s=default; t=1601260122; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=0HD8fTXb4t1no4R00sB8iNaXF8rPU+FE04lPwUcJAaU=; b=gXOnRyINLXXLnd8tX1hbz+5n2e8EGJUystM9qn83OdgOWA3Cfx7hNZ8LVW1xgyJ2swD0eV 0L5d4dy+Wt0DF115i/wns3ejPP76Y0bH2ziqF4dJxJI6AxJaZI3Rgx9m8vlSuKat8jgSq6 ftrZAVW30sTe6TeObwb968PjE22q2go= From: Pedro Lucas Porcellis To: cgit@lists.zx2c4.com Cc: Pedro Lucas Porcellis 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> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: cgit@lists.zx2c4.com X-Mailman-Version: 2.1.30rc1 Precedence: list List-Id: List for cgit developers and users List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: cgit-bounces@lists.zx2c4.com Sender: "CGit" 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