Gabe/ASCIIsite
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 2 Wiki Activity

updated readme for new feature

Browse source
This commit is contained in:
gabe 2021-09-26 12:45:45 -05:00
parent 3ffc96453e
commit 08a5683906
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -11,13 +11,17 @@ ASCIISite takes 2 (so far) optional arguments followed by the single mandatory a
the -o or --output option simply tells ASCIISite what to name the output file.
the --exclude flag allows you to specify a list of glob patterns. Any file matching these glob patterns will not be copied to the output.
This is helpful for any files that are needed for the compilation of the asciidoc files, but do not need to be in the final site.
The main use case I am aware of is files that are put into an asciidoc document via an include statement.
the -z or --compress flag tells ASCIISite to put the final product in a compressed tar.gz file as its output.
This is especially useful if you are running ASCIISite on your personal computer, and will be uploading the tar.gz file to your server.
the --exclude flag allows you to specify a list of glob patterns. Any file matching these glob patterns will not be copied to the output.
The --exclude-file flag allows you to specify a file containing one glob to exclude per line. Other than inputting from a file, works exactly the same as --exclude. Note that it cannot parse the full spec of .gitignore files, only traditional globs.
Exclusions are helpful for any files that are needed for the compilation of the asciidoc files, but do not need to be in the final site.
The main use case I am aware of is files that are put into an asciidoc document via an include statement.
As for how to format the input directory, thats up to you. The directory structure of the input will be mirrored in the structure of the output website.
The only real rule you need to follow is that all your links to other pages in the input directory should be relative, so they dont get broken when you move the output directory around.