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

Rethink index.hbs organization #353

Open
budziq opened this issue Jun 23, 2017 · 0 comments
Open

Rethink index.hbs organization #353

budziq opened this issue Jun 23, 2017 · 0 comments
Labels
A-HTML Area: HTML Rendering C-refactor Category: Code refactoring M-Discussion Meta: Discussion

Comments

@budziq
Copy link
Contributor

budziq commented Jun 23, 2017

As discussed in https://github.com/azerupi/mdBook/pull/338#discussion_r123618836

Discussion points:

index.hbs is currently coupled to hbs_renderer and book.js. Book substituting the index with their own, takes a large maintenance burden and looses bugfixes and new features.

  • Consider splitting index.hbs into core.hbs (all the js includes and core styles) and index.hbs that would be almost empty and easily replaceable.
  • possibly make the other parts replaceable (sidebar, top bar , theme chooser)
  • consider adding optional edit button like in rust-cookbook
@budziq budziq mentioned this issue Jun 23, 2017
@azerupi azerupi added A-HTML Area: HTML Rendering M-Discussion Meta: Discussion C-refactor Category: Code refactoring labels Jun 24, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-HTML Area: HTML Rendering C-refactor Category: Code refactoring M-Discussion Meta: Discussion
Projects
None yet
Development

No branches or pull requests

2 participants