help write Don't Starve Docs
- update/delete/rename cache file when you save/delete/rename file automatically
- context menu:
- generate the Markdown file in the
mdDir
directory which is corresponding to the code file - generate the
SUMMARY.md
file associated with themdDir
directory - open the associated files at the same time
- export or don't export parts (ctrl + d)
- generate the Markdown file in the
see example
{
"dstutils.mapRules": [
{
"src": { "dir": "temp/scripts-DST", "ext": ".lua", "position": "right" },
"dst": { "dir": "docs/", "ext": ".md", "position": "left" },
"cache": {
"src": { "dir": "docs/", "ext": ".md" },
"dst": { "dir": "assets/cache/", "ext": ".json" }
},
"exclude": ["README", "SUMMARY"]
}
]
}
Force newlines to be LF
(used in Linux/Mac) instead of CRLF(used in Windows), so recommend Windows users to work in the WSL(Windows Subsystem for Linux) environment. Another way is to configure git
and VSCode
to convert CRLF to LF automatically:
The below forces git
to convert CRLF to LF automatically:
git config --global core.autocrlf true
The below forces VSCode to use LF when creating new files:
{
"files.eol": "\n"
}