Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

index.md: Add a single-page overview for easy printing #264

Closed
wants to merge 1 commit into from

Conversation

wking
Copy link
Contributor

@wking wking commented Dec 9, 2015

As an alternative to #263. Example HTML currently here, and it's
not especially beautiful (e.g. it has the same “links point out of
the file
” issue. But we can fix/mitigate some of those issues
with Makefile rules and a gh-pages release build. The pandoc/LaTeX
approach from #263 could fix link targets with similar Makefile rules,
so I think it's a wash there. But this approach seems better to me
because “push to gh-pages” is a smaller barrier-to-entry than “install
this pandoc/LaTeX docker image”.

The _includes directory holds copies of files to avoid:

A file was included in index.md that is a symlink or does not exist
in your _includes directory. For more information, see
https://help.github.com/articles/page-build-failed-file-is-a-symlink.

The _includes directory holds copies of files to avoid:

  A file was included in index.md that is a symlink or does not exist
  in your _includes directory. For more information, see
  https://help.github.com/articles/page-build-failed-file-is-a-symlink.

Signed-off-by: W. Trevor King <wking@tremily.us>
@wking
Copy link
Contributor Author

wking commented Dec 9, 2015

In case it wasn't clear from my topic message, d57693a is just a proof-of-concept sketching out this approach. If it seems like a useful direction, I can add some of the polishing I mentioned in the topic message (e.g. we'll want a rule to automatically copy *.md into _includes).

@wking
Copy link
Contributor Author

wking commented Dec 21, 2015

The #263 approach landed, so there's no need for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant