metalsmith-assets
metalsmith-assets copied to clipboard
Published
20 hours ago •
treygriffith
treygriffith
WTF documentation
OK, I'm calmer now, will rewrite this issue on how to improve your documentation.
In the example code, you talk about "relative to the working directory" and "relative to the build directory" I'm sure I was overthinking, but these aren't obvious to a newbie.
The build directory is the target of Metalsmith.destination(), right???. Why not call it the destination directory? Or "The directory you pass to destination()"? Would clarify IMO.
Much more confusing is "working directory". I can think of at least three things that it could be.
- The directory containing the .js file (or the .json file) to build the metalsmith project.
- The current working directory of your computer, which is probably === #1 but possibly not
- The source directory (that you passed to
source())
You should elaborate, and possibly revise to say "source", if the answer is #3.
On a side note, an option to "overwrite" or "noOverwrite" (or "clobber" if you like that better) might be nice.
