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

Change directory layout and include:: macro calls in a way which is compatible with Gitbook.io #20

Open
xtaran opened this issue Nov 17, 2015 · 0 comments

Comments

@xtaran
Copy link
Member

xtaran commented Nov 17, 2015

Currently Gitbook.io doesn't support Asciidoc's include:: macros, see GitbookIO/gitbook#1015. The document structure needs to be defined manually in a file called SUMMARY.adoc with an ordered and nested list containing link: macros. We can generate that SUMMARY.adoc from our current structure by finding all occurrences of include:: macros. The script bin/generate-gitbook-summary.pl in the gitbook branch does that already.

Gitbook.io seems to ignore all files which don't generate content already, i.e. those only containing more than just include:: macros (e.g. a header) are included. But if content and include:: macros are mixed, we get ugly hyperlinks labed with the .adoc file name despite pointing to the right .html file (in the online book). We should be able to avoid them by splitting up all files with such mixed contents.

@xtaran xtaran added this to the Gitbooks.io milestone Nov 17, 2015
@xtaran xtaran changed the title Change directory layout and include:: macro calls in a way which is compatible with Gitbooks.io Change directory layout and include:: macro calls in a way which is compatible with Gitbook.io Nov 17, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant