Телеграмм чат группы frontendua страница 1700

2020 October 20

VS

V7v S6k in Frontend UA

там можна у вебі публікувати це все

https://publish.obsidian.md/help/Plugins/Publish

источник

18:21пожаловаться #1

AR

Alexey Raspopov in Frontend UA

Eugene Obrezkov

ну от например есть у нас

- docs/<feature X>/getting-started.md
- docs/<feature X>/advanced-usage.md
- docs/<feature Y>/migration.md
- ...

хочется из этого добра теперь нагенерить KB, который сможет распознать референсы между собой и сгенерировать user-facing страницу (README.md) по которой пользователь смог бы найти всё что ему нужно

Не уверен по поводу генерации README.md, но я однажды для подобной задачи использова vuepress с их дефолтным шаблоном: генерирует статику, приятную и читабельную, даже с поиском

источник

18:22пожаловаться #2

EO

Eugene Obrezkov in Frontend UA

Alexey Raspopov

Не уверен по поводу генерации README.md, но я однажды для подобной задачи использова vuepress с их дефолтным шаблоном: генерирует статику, приятную и читабельную, даже с поиском

в нашем случае это будет мега неудобно с точки зрения паблиша

источник

18:25пожаловаться #3

EO

Eugene Obrezkov in Frontend UA

так-то я бы уже jekyll затащил)

источник

18:25пожаловаться #4

EO

Eugene Obrezkov in Frontend UA

поэтому и хочется выкрутиться на статике в гите

источник

18:25пожаловаться #5

AL

Andrey Listochkin in Frontend UA

Так а чем не устраивает пачка MD-файлов в гит-репозитории? Если указывать raltive path в линках, то когда запушишь, на сайте GitHub эти ссылки будут работать

источник

18:50пожаловаться #6

EO

Eugene Obrezkov in Frontend UA

Andrey Listochkin

Так а чем не устраивает пачка MD-файлов в гит-репозитории? Если указывать raltive path в линках, то когда запушишь, на сайте GitHub эти ссылки будут работать

не устраивает, что помимо написания доки надо будет ещё ридми править с добавлением ссылки

источник

18:52пожаловаться #7

EO

Eugene Obrezkov in Frontend UA

но это такое, мелочи, я надеялся что это можно автоматизировать

источник

18:52пожаловаться #8

AL

Andrey Listochkin in Frontend UA

т.е. ты ссылки не расставляешь, а какие-то кастомные метки, и чтоб тебе штука какая-то по меткам ссылки генерила?

источник

18:53пожаловаться #9

Вт

Ві тя in Frontend UA

прикольно, сльішал когда-то о каком-то решении в етом чате, но уже не помню каком

источник

18:54пожаловаться #10

SG

Stas G in Frontend UA

)))))

источник

18:55пожаловаться #11

SG

Stas G in Frontend UA

Ві тя

прикольно, сльішал когда-то о каком-то решении в етом чате, но уже не помню каком

как вспомнишь – сообщи

источник

18:56пожаловаться #12

EO

Eugene Obrezkov in Frontend UA

Andrey Listochkin

т.е. ты ссылки не расставляешь, а какие-то кастомные метки, и чтоб тебе штука какая-то по меткам ссылки генерила?

да, ещё круче было бы, если бы она понимала связи без меток, типа "о, тут вспомнили вот эту штуку, я её уже видел вот там-то и сама ссылку сделала"

источник

19:14пожаловаться #13

EO

Eugene Obrezkov in Frontend UA

у нас вся дока в одном большом ридми и вот хочется это разбить на поддерживаемые небольшие мд файлы, на каждую фичу своя папка в docs, там и как пользоваться и миграции и т.п.

источник

19:18пожаловаться #14

EO

Eugene Obrezkov in Frontend UA

но при этом, чтобы разработчики заходя к нам в репу сразу видел индекс в котором можно найти всё и оно поведёт куда надо

источник

19:19пожаловаться #15

AL

Andrey Listochkin in Frontend UA

Eugene Obrezkov

да, ещё круче было бы, если бы она понимала связи без меток, типа "о, тут вспомнили вот эту штуку, я её уже видел вот там-то и сама ссылку сделала"

Можно написать самому скриптик, который соединит одно с другим.

Типо $$$ANCORNAME$$$ там куда нужна ссылка
и $$$LINK-ANKORNAME$$$ в том месте, куда ссыль надо поставить

или даже так:

$$$Начало заголовка$$$

И потом твой скрипт находит этот заголовок в файлах, и генерит линк к нему.

Сделать это вначале, когда иде деребан ридмишки, а потом люди пусть руками ссылки делают, когда фалы редактируют

источник

19:49пожаловаться #16

Вт

Ві тя in Frontend UA

Andrey Listochkin

Можно написать самому скриптик, который соединит одно с другим.

Типо $$$ANCORNAME$$$ там куда нужна ссылка
и $$$LINK-ANKORNAME$$$ в том месте, куда ссыль надо поставить

или даже так:

$$$Начало заголовка$$$

И потом твой скрипт находит этот заголовок в файлах, и генерит линк к нему.

Сделать это вначале, когда иде деребан ридмишки, а потом люди пусть руками ссылки делают, когда фалы редактируют

можно еще написать небольшую лямбду которая вьітащит по github search api первое вхождение слова поиска и даст редирект сразу куда надо

источник

20:38пожаловаться #17

AR

Alexey Raspopov in Frontend UA

через месяц: docs index ops team

источник

20:38пожаловаться #18

EO

Eugene Obrezkov in Frontend UA

Ві тя

можно еще написать небольшую лямбду которая вьітащит по github search api первое вхождение слова поиска и даст редирект сразу куда надо