5

Как сделать принцип работы "содержания" как в MS Word?
Например, есть содержание и при нажатии на какой-либо пункт, автоматом перепрыгивает на него в тексте.

Kromster
  • 13,809

2 Answers2

8

Если необходимо, чтоб вся информация была только в одном README.md и соответственно была навигация для удобности пользователя, лучше конечно воспользоваться якорями, про которые упомянул в комментариях @ArchDemon

Помести в нужном месте якорь:

<a name="твоё_название"></a> 

и там где это необходимо, ссылку на этот якорь:

[Текст ссылки](#твоё_название)
3

Если нужно делать внутренние ссылки к заголовкам, то не обязательно использовать html-теги, как рекомендует @user262779. Можно использовать следующую конструкцию:

[отображаемое название](#название-заголовка)

То есть в круглых скобках все буквы в нижнем регистре и слова разделены дефисом. Более того, если в названии есть скобки, знаки пунктуации и т.д. их писать не следует. Еще момент: неважно какого уровня заголовок, в круглых скобках всегда один символ решетки! Так же рекомендую ознакомиться с, как я понимаю, переводом руководства на русский.


Я, например, редактирую файл в intellij idea и на этапе когда у меня написано:

[отображаемое название]()

Достаточно добавить в круглые скобки "#", чтобы появился выпадающий список со всеми возможными вариантами. Очень удобно.