pomp/pompy.dev
1
0
Fork 0
Code Issues 8 Pull requests Activity Actions

improved file description

Browse source
This commit is contained in:
Kim, Jimin 2021-12-15 11:40:45 +09:00
parent b6c3fe5517
commit 744547148e
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
source/generate.ts
View file

@ -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