search

FransBouma / DocNet

Your friendly static documentation generator, using markdown files to build the content.
http://fransbouma.github.io/DocNet/
248 stars 36 forks source link

Where to store the attachments #51

Closed GeertvanHorrik closed 7 years ago

GeertvanHorrik commented 7 years ago

Just a question someone might have already solved. Where do you store the attachments?

  1. In a separate includes/attachments folder (nested or flat)
  2. Next to the md src files
FransBouma commented 7 years ago

what do you mean exactly with 'attachments' ? :)

GeertvanHorrik commented 7 years ago

Images, zip files with examples, etc

FransBouma commented 7 years ago

Ah! In a separate folder. See: "SourceFoldersToCopy" in the docnet.json file. The folders specified (see docnet.json doc http://fransbouma.github.io/DocNet/docnetjson.htm) are relative to source.

GeertvanHorrik commented 7 years ago

I found that, but it looks kind of weird to separate images from md files, but guess it's just getting used to.

FransBouma commented 7 years ago

ah I see what you mean. If you look at an md file and the support files for it (images) as a unit it indeed looks weird, but the idea in docnet is that the files combined form a unit, the site. Therefore having images in a separated folder, dedicated for that, makes sense, after all it's common practice to do it that way for a normal website too.

GeertvanHorrik commented 7 years ago

Thanks, makes sense.