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

SUMMARY.md support for non-list elements #9

Closed
2 tasks done
azerupi opened this issue Jul 29, 2015 · 4 comments
Closed
2 tasks done

SUMMARY.md support for non-list elements #9

azerupi opened this issue Jul 29, 2015 · 4 comments
Milestone

Comments

@azerupi
Copy link
Contributor

azerupi commented Jul 29, 2015

In SUMMARY.md support non-list entries:

For example:

# Summary

[Introduction](README.md)
[Foreword](foreword.md)

- [chapter 1](chapter_1.md)
- [chapter 2](chapter_2.md)

[Appendix](appendix.md)
--------------------
[Contributors](contributors.md)
[License](license.md)
  • non-list link would be rendered without the section (chapter number)
  • separator to separate some parts
@azerupi azerupi added this to the 0.0.2 milestone Aug 11, 2015
@FuGangqiang
Copy link
Contributor

what is the section number below?

[Foreword](foreword.md)
- [chapter 1](chapter_1.md)    # number == 1
[example](example.md)
- [chapter 2](chapter_2.md)    # number == 2 ?
[Appendix](appendix.md)

and

[Foreword](foreword.md)
    [chapter 1](chapter_1.md)   
        - [example](example.md)   # number == 1.1 ?
    - [example2](example2.md)     # number == 1 ?
- [chapter 2](chapter_2.md)       # number == 1 ?
[Appendix](appendix.md)

@azerupi
Copy link
Contributor Author

azerupi commented Sep 3, 2015

I think non-list elements should be root elements only. But I am not sure if lists should reset or not. What do you think is better?

@FuGangqiang
Copy link
Contributor

I think

  • non-list should be root elements only
  • not-list should not have subitem
  • lists should not be break by non-list

that will not lead to ambiguity, and what do you think?

@azerupi
Copy link
Contributor Author

azerupi commented Sep 4, 2015

Yes, that sounds good. :)

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