thewhitetulip/web-dev-golang-anti-textbook

Some header levels are inconsistent, spacing off

atc0005 opened this issue · 5 comments

atc0005 commented

Some headers jump sequence, others have inconsistent spacing around them which (I vaguely recall) interferes with some rendering.

Going to reference this issue for an upcoming PR, potential further discussion.

atc0005 commented

Note to self for checking against later:

https://leanpub.com/lfm/read#leanpub-auto-booktxt-sampletxt-and-manuscript-files

While I do believe that there are still a few places that might require adjustment, it seems that some of my thinking was based entirely on ignorance. As noted in the link above:

When Leanpub converts this text into a book for you, the # headings will start new chapters and the ## headings will start new sections.

and:

Heading Levels Become Chapters and Sections

First, we use # chapters, ## for sections and ### for sub-sections. (You can also use #### for sub-sub-sections, but don’t get carried away! Most technical books are good with just #, ## and ###, and most business and fiction books are good with just # and possibly ##.)

atc0005 commented

WIP. See atc0005/web-dev-golang-anti-textbook@164c942 for the types of changes that I'm working to include in a PR associated with this issue.

  • 👍1
atc0005 commented

@thewhitetulip

For the manuscript\3.0templating.md file, can you please confirm whether this was the intended hierarchy?

  • Templates
    • template.must
    • Sub templating
      • Example
    • Looping through arrays
    • Template variables
    • Creating variables
    • Homework
    • Links

I wasn't sure which sections are subsections (if any) of Example and which are second level sections like Sub templating appear to be.

Thanks.

atc0005 commented

A second question, this one regarding manuscript\2.2database.md:

Do you intend for that file to be one main chapter (header level 1) with subsections, or several chapters (multiple headers at level 1)?

I'm guessing the former and will update the doc file to reflect that approach.

atc0005 commented

Alright, I think I have this mostly done. I'll go ahead and open a draft PR on the assumption that will make it easier to review the proposed changes. If the direction looks good I'll squash the commits for a final approval.