afiorillo / dds Goto Github PK

• Template for folders with no index
• Template for rendered markdown files

The server should be able to serve Jinja HTML templates just like plain HTML, Markdown, etc. Populate fields to render Jinja files with JSON, Python, etc.

Path Rules:

1. / is equivalent to {public_dir}/index.html
2. /{subdir} and /{subdir}/ are equivalent to {public_dir}/{subdir}/index.html
3. (2) can be repeated recursively.

File Rules:
In any directory, the index.html file will be produced in the priority of:

1. If there is an actual index.html file, that's served.
2. If there is no index.html file, the default template is rendered and served.

Creates a folder, fills it with basic templates and docs, etc.

At least usage docs. Stuff that answers the questions:

• How should I handle paths inside of my directories? (E.g. each directory is a separate and distinct output of Sphinx).
• How do I specify layouts? Styles? Static files?

Build up a testing public_dir, use Travis CI to spin up the server and then CURL against it or something to test that everything works.

Anywhere an HTML file could be served (including index.html in any directory), it should be possible to use a similarly named .md file and render it into HTML.

• Maybe render it according to some Jinja template?
  This could be done with priority in the specific directory, then a site-wide default as well.
• Maybe make a pre-processor pipeline to handle other filetypes (EJS, Jinja, etc.)

Maybe at the root of the public_dir there are just more directories, but no files. Some automatic HTML page should be generated that acts as a portal to the inner directories.