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

Wiki или список сниппетов #35

Open
leotop opened this issue Oct 17, 2019 · 8 comments
Open

Wiki или список сниппетов #35

leotop opened this issue Oct 17, 2019 · 8 comments
Labels
documentation Improvements or additions to documentation

Comments

@leotop
Copy link
Contributor

leotop commented Oct 17, 2019

Хотелось бы видеть сразу весь список имеющихся сниппетов на вики странице или отдельным файлом.

В списке по возможности сделать TODO, что желательно добавить.

Файлов стало много, сложно ориентироваться, что есть, чего еще нет.

@lord-alfred lord-alfred added the documentation Improvements or additions to documentation label Oct 17, 2019
@lord-alfred
Copy link
Member

Уже обсуждали в чате, что в идеале нужно генерировать документацию (список сниппетов + их описания) из самих сниппетов (парсингом начальных строк с комментариями). Похожим образом генерируется документация по встроенным методам ZennoPoster (см.: https://help.zennolab.com/en/v5/zennoposter/5.30.0.0/webframe.html ).

Затем можно было бы полученные html разместить в ветке для github pages, а потом попросить у разработчиков ZP сделать поддомен аля snippets_zennolab_com и прикрутить его по CNAME.

Пока что на этой стадии было решено собрать как можно больше сниппетов в принципе, чтоб посмотреть кто как их оформляет и решить как раз каким образом стоит их потом парсить. Думаю, стоит ещё подождать какое-то время, чтоб оставшиеся желающие добавили свои сниппеты через PR, а уже в дальнейшем думать о генерации документации (потому что есть подозрения, что без активного участия сообщества - данный репозиторий может заглохнуть и в итоге никто не будет добавлять новый код, а значит и решать задачу генерации документации пока что преждевременно).

@leotop
Copy link
Contributor Author

leotop commented Oct 17, 2019

Речь не о документации, а обычном списке, просто листинг файлов.

@lord-alfred
Copy link
Member

Я об этом и написал, только в разрезе той мысли, что оно будет генерироваться автоматически (чтоб не добавлять в этот список руками новые сниппеты).

Если есть другие идеи, то было бы здорово услышать, Вдруг я слишком хардкорно хочу решать задачу :)

@lord-alfred
Copy link
Member

Лайфхак: если зайти на главную страницу репозитория и нажать кнопку "t", то откроется поиск по именам файлов. Очень удобно ;-)

Или можно попасть туда, перейдя по следующей ссылке: https://github.com/ZennoHelpers/Snippets/find/master

@Zymlex
Copy link
Member

Zymlex commented Oct 17, 2019

Или можно попасть туда, перейдя по следующей ссылке: https://github.com/ZennoHelpers/Snippets/find/master

Не весь список отображается.

Если есть другие идеи, то было бы здорово услышать, Вдруг я слишком хардкорно хочу решать задачу :)

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

@lord-alfred
Copy link
Member

Не весь список отображается.

Там можно ещё начать вводить название сниппета и он покажет то, что есть с таким именем

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

Ну, а там и не долго допилить чтоб первые строки с комментарием ещё заодно парсились, а потом это всё в красивый html вставлялось :)
Не, конечно, можно начать и с просто генерации батником листинга файлов и его так и закидывать в ветку github pages, но вроде как интереснее написать небольшой аля парсер на C# ))

@leotop
Copy link
Contributor Author

leotop commented Oct 20, 2019

Через API функции нет, для githab pages, отображения файлов?

@lord-alfred
Copy link
Member

К сожалению, я о таком функционале не знаю :(
Если есть, то может и вправду было бы проще его прикрутить как-то

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

3 participants