8000 Handle single md better · Issue #14 · Shoes3/ebook · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Handle single md better #14

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

Open
ccoupe opened this issue Jan 3, 2017 · 4 comments
Open

Handle single md better #14

ccoupe opened this issue Jan 3, 2017 · 4 comments
Assignees
Milestone

Comments

@ccoupe
Copy link
Member
ccoupe commented Jan 3, 2017

I came across a README.md that was structured in an interesting way that I'm pretty sure would not fit with what we've done so far. It had a couple of paragraphs of how to install the gem followed by an in-page menu of created with md ordered lists, and sub lists 'ol, ul' in html terms that pointed to html page anchors ( url#my-2.3) And then the actual document with anchors mixed in to the headers. Very clever. I should have saved the url but it's easy enough to modify our README.md to create that.

@IanTrudel
Copy link
Collaborator

Header anchors seems something we can handle. It's basically a link as in [link](#anchor).

@IanTrudel IanTrudel added this to the 1.0.0 milestone Jan 3, 2017
@ccoupe
Copy link
Member Author
ccoupe commented Jan 8, 2017

seems something we can handle. It's basically a link as in link.

Actually, it's not that simple w/o some vicious and ugly special casing in the kramdown parsers. It can be done but no one is going to like it. We don't have way to move inside a single document.

@ccoupe
Copy link
Member Author
ccoupe commented Jan 13, 2017

What has to be done here is a lot like if we had Shoes-manual.md in one big file. Currently the generated Shoes/Ruby to be evaluate is tied to a file name (.md) because in the general case there can be many md files in many directories - sections (or chapters if you like). The show_render navigation code knows that.

It's certainly possible to call a different set of Kramdown parsers/converters - we already detect this situation as 'one file', 'no menus' and it just barely gives a Shoes experience. That said, it's a lot of work.

@ccoupe ccoupe self-assigned this Jan 15, 2017
ccoupe pushed a commit that referenced this issue Jan 15, 2017
* generate sections/subsections based on headers - level and text
  Just what we need for a Shoes-manual.md - if it existed
* WIP - doesn't work
@ccoupe
Copy link
Member Author
ccoupe commented Jan 17, 2017

I actually have something to work with. This the README.md (Tests/single/foobar.md)
deeplook-begin

Obviously it should not display double subsub-sections, and only the second displays something. The screen capture is 'Harder Install' and it shows many problems with the generated Shoes/Ruby. Some problems will be easy and some not so easy.

ccoupe pushed a commit that referenced this issue Jan 24, 2017
  * create 'synthetic' section so we can display the opening info
   again.  Other ebook 'types' need this too.
  * kramdowm -> Shoes/ruby really sucks.
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

No branches or pull requests

2 participants
0