freeman-lab / minidocs

build a minimalist site for your documentation
MIT License
137 stars 19 forks source link

properly read & render markdown files in subdirectories #53

Open sethvincent opened 8 years ago

sethvincent commented 8 years ago

Right now only the files in the top level markdown directory are read.

It's easy to make a change that recursively reads the files by changing the filter argument passed to read-directory, but currently the name of the subdirectories are excluded from the resulting object keys.

Main questions:

This is somewhat related to #5, inferring the table of contents from the directory structure

joehand commented 8 years ago

Should the routes of the app reflect the directory structure?

This makes sense to me.

If routes reflect directory structure, what should happen when a markdown file is at /test/foo and a user navigates to /test/? Probably just show the first matching file?

Sounds good. When you say first, is that first alphabetically or first in the TOC (latter would be preferable)?