djkeh / flybook Goto Github PK

In layout.js year is hardcoded in footer tag, therefore it always shows 2017 after rendering markdown document. It could possibly be better to show "this year".

This issue concerns about polishing entire flybook documents.

• website: https://flybook.js.org/

as-is

Flybook currently treats document filenames to titles in sidebar. There's a slight change of naming happening at this moment, and it figures out like:

• 1._sample_doc.md -> 1 Sample Doc
• 1.-sample-doc.md -> 1 Sample Doc
• 1_-_sample_doc.md -> 1 Sample Doc

It seems like one of the policies to handle blanks and special characters.

to-be

This issue suggests to put numbering at the head of each titles(by simply accepting dot(.)), and it might look like:

• 1._sample_doc.md -> 1. Sample Doc

This issue is to examine whether the idea above is possible, and implement the feature if possible.

as-is

Flybook renders list elements like below:

The markup is being rendered as:

<ul>
  <li>Neo4j에서 관계는 항상 방향이 있음을 기억</li>
  <li>사이퍼 문법에는 대소문자 구분 없음</li>
  <li>
    <p>레이블, 노드 식별자, 속성, 값 등에는 대소문자 구분</p>
    <ul>
      <li>함수나 정규식을 통해, 대소문자 구분 없는 검색은 가능</li>
    </ul>
  </li>
  <li>주석 사용 가능: <code>//</code></li>
</ul>

It shows that there's some more room for improvement for the spacing between lines by fixing part of markup rendering result and the css.

to-be

The markup should be rendered as:

<ul>
  <li>Neo4j에서 관계는 항상 방향이 있음을 기억</li>
  <li>사이퍼 문법에는 대소문자 구분 없음</li>
  <li>
    레이블, 노드 식별자, 속성, 값 등에는 대소문자 구분
    <ul>
      <li>함수나 정규식을 통해, 대소문자 구분 없는 검색은 가능</li>
    </ul>
  </li>
  <li>주석 사용 가능: <code>//</code></li>
</ul>

• removes <p> tag which seems redundant and makes extra vertical margin to get more space, breaking harmony and consistency with the rest of the list items
• changes css li+li to li to have all <li>tags have same upper margin to give complete consistency

This issue is to examine whether the idea above is possible, and implement the feature if possible.

Reference

This issue is directly related to rhiokim#21

• markup ref.: https://www.w3schools.com/html/html_lists.asp
• markup test: https://validator.w3.org/