Initial Bitbucket→GitHub migration commit, based on release v2.0.0.

This commit is contained in:
Thomas M. Edwards 2019-12-23 13:45:15 -06:00
commit 57e1aa52ff
36 changed files with 5026 additions and 0 deletions

52
docs/core/faq-and-tips.md Normal file
View file

@ -0,0 +1,52 @@
<!-- ***********************************************************************************************
FAQ & Tips
************************************************************************************************ -->
<h1 id="faq-and-tips">FAQ &amp; Tips</h1>
This is a collection of tips, from how to avoid pitfalls to best practices.
Suggestions for new entries may be submitted by [creating a new issue](https://bitbucket.org/tmedwards/tweego/issues?status=new&status=open) at Tweego's [code repository](https://bitbucket.org/tmedwards/tweego/). **NOTE:** Acceptance of submissions ***is not*** guaranteed.
<!-- ***************************************************************************
Avoid processing files
**************************************************************************** -->
<span id="faq-and-tips-avoid-processing-files"></span>
## 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
**************************************************************************** -->
<span id="faq-and-tips-convert-twee2-files-to-tweev3"></span>
## Convert Twee2 files to Twee&nbsp;v3
You may convert a Twee2 notation file to a Twee&nbsp;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, like so:
```
tweego --twee2-compat -d -o twee_v3_file.twee twee2_file.twee
```