2.1 KiB
FAQ & Tips
This is a collection of tips, from how to avoid pitfalls to best practices.
Note: Suggestions for new entries may be submitted by creating a new issue at Tweego's source code repository—though acceptance of submissions is not guaranteed.
Avoid processing files
The way to avoid having Tweego process files is to not pass it the files in the first place—i.e., keep the files in question separate from the files you want Tweego to compile.
Using image files as an example, I would generally recommend a directory structure something like:
project_directory/
images/
src/
Where src is the directory you pass to Tweego, which only contains files you want it to compile—and possibly files that it will not process, like notes and whatnot. For example, while within the project directory the command:
tweego -o project.html src
Will only compile the files in src, leaving the image files in images alone.
Convert Twee2 files to Twee v3
You may convert a Twee2 notation file to a Twee v3 notation file like so:
tweego -d -o twee_v3_file.twee twee2_file.tw2
Or, if the Twee2 notation file has a standard Twee file extension (.tw, .twee), like so:
tweego --twee2-compat -d -o twee_v3_file.twee twee2_file.twee