Skip to content
This repository has been archived by the owner on Jan 3, 2018. It is now read-only.

Add headers at Markdown blank example #725

Merged
merged 1 commit into from
Sep 30, 2014

Conversation

rgaiacs
Copy link

@rgaiacs rgaiacs commented Sep 18, 2014

@gvwilson I don't remember why our sections use h3. Do you remember?

@gvwilson
Copy link
Contributor

When we stitch things together to make a book, h1 is the book title,
h2 is the chapter titles (e.g. "Python", "Git"), so h3 is the title
for the sections (e.g., the heading of novice/python/03-loop should be
an h3), and headings inside a lesson should all be h4.

@wking
Copy link
Contributor

wking commented Sep 18, 2014

On Thu, Sep 18, 2014 at 03:49:42PM -0700, Greg Wilson wrote:

When we stitch things together to make a book, h1 is the book title,
h2 is the chapter titles (e.g. "Python", "Git"), so h3 is the title
for the sections (e.g., the heading of novice/python/03-loop should be
an h3), and headings inside a lesson should all be h4.

For what it's worth, HTML lets you just use

everywhere (thanks to

) [1](https://html.spec.whatwg.org/multipage/semantics.html#headings-and-sections).

@rgaiacs
Copy link
Author

rgaiacs commented Sep 19, 2014

For what it's worth, HTML lets you just use

everywhere (thanks to

) [1].

I don't know if it will play nice with pandoc when we try to create the EPUB and
PDF version of the lessons.

And please don't merge it yet. I want to add the same text to the IPython
Notebook example.

rgaiacs referenced this pull request in rgaiacs/bc Sep 24, 2014
@rgaiacs
Copy link
Author

rgaiacs commented Sep 27, 2014

I notice that IPython Notebook template already has a note about this:

Use a Heading-3 for Subsection Headings

@gvwilson If this looks OK we could merge it.

@wking about <h1> and <section> I want to postpone this change so I could have time to play and find out how pandoc deal with it.

@gvwilson
Copy link
Contributor

Keep this or discard it in the run up to #759?

@rgaiacs
Copy link
Author

rgaiacs commented Sep 30, 2014

@gvwilson I'm merging this before #759.

rgaiacs pushed a commit that referenced this pull request Sep 30, 2014
Add headers at Markdown blank example
@rgaiacs rgaiacs merged commit 2b35a7a into swcarpentry:master Sep 30, 2014
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants