From 744547148efb979426a70359308c23d0edcda440 Mon Sep 17 00:00:00 2001 From: developomp Date: Wed, 15 Dec 2021 11:40:45 +0900 Subject: [PATCH] improved file description --- source/generate.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/generate.ts b/source/generate.ts index ff263eb..2d24d38 100644 --- a/source/generate.ts +++ b/source/generate.ts @@ -1,9 +1,9 @@ /** - * Read markdown files and write their content and metadata to json files which can then be imported by React. - * - File and directory names starting with an underscore (_) get ignored. + * @file Read markdown files and write their content and metadata to json files which can then be imported by React. + * - File and directory names starting with an underscore (_) are ignored. * - Symbolic links are not supported. - * - The Filename-to-URL encoder is not perfect. Some non-URL-friendly filenames might cause problems. - * - series must start with a number followed by an underscore + * - The filename-to-URL converter isn't perfect. Some non-URL-friendly filenames might cause problems. + * - series must start with a number followed by an underscore */ import fs from "fs" // read and write files