martinthomson / i-d-template

A template for IETF internet draft git repositories
Other
212 stars 183 forks source link

build-index.sh #246

Closed mnot closed 3 years ago

mnot commented 4 years ago

I'm starting to use a jekyll remote template to pull together the look and feel of how httpwg repos are presented, and it's going well.

However, the index.html created by i-d-template poses two problems:

  1. It conflicts with taking up the README file as the default for the repo, which is sometimes desirable.
  2. It's in HTML, not markdown, so it's more difficult to style (e.g., adding a navigation bar).

I think this could be addressed by:

  1. Making the name of the file configurable
  2. Allowing optional markdown output instead of HTML

@martinthomson if you're amenable I suspect you'd be more efficient at (1); I can take a stab at (2), although hooking in the control mechanism might be better done by you. WDYT?

mnot commented 4 years ago

The underlying use case is that I want to mix repo content with the index, rather than only having the index and generated drafts available. This is both in terms of controlling the presentation of the index (hence, markdown) and inclusion of other files.

Thinking about it a bit more, I think that (1) isn't strictly necessary; what would help is (2) as well as the ability to include some content in the markdown (probably just other static markdown, e.g., from the repo's README.md).

martinthomson commented 3 years ago

@mnot - is this now satisfactory?

mnot commented 3 years ago

Hmm. I've set MD_INDEX := true, but it still generates index.html, which overrides the markdown for index views.

martinthomson commented 3 years ago

Ah, something got lost somewhere. Try INDEX_FORMAT := md instead.

mnot commented 3 years ago

Seems to work fine, thanks! I've got it going for http-extensions and http2-spec now.

@LPardue if you want https://quicwg.org/base-drafts/ to be prettier (see e.g., https://httpwg.org/http-extensions/ ) try this; you'll need to have a theme repo (like https://github.com/httpwg/theme) and point to it in _config.yml.