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

Fix markdown heading levels #11

Open
kevinbader opened this issue May 4, 2020 · 0 comments
Open

Fix markdown heading levels #11

kevinbader opened this issue May 4, 2020 · 0 comments

Comments

@kevinbader
Copy link

Problem description

c4builder currently assumes that markdown files don't use h1 (#) and h2 (##) headers. For example:

image

If you don't know this, you might be tempted to start with a h1 heading, which is what you'd usually do. Then it looks like this:

image

This is probably not what you want. Even more obvious in case of generated markdown:

# test

* [Overview](#Overview)
* [src](#src)
  * [foo](#foo)

---

## Overview

# Top-level readme h1

top-level readme content

And here's the PDF view:

image

Thoughts

  • Most projects use a h1 heading with their project name in the top-level readme file. If that is present, there's no need to render the project name separately or define a HOMEPAGE_NAME. (Related to Use top-level README file #9.)
  • To prevent forcing users to use only level 3+ headings, c4builder could alter heading levels in the build process.

Thoughts?

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

1 participant