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

Доработки модуля "DOC" #5

Closed
yupe opened this issue Apr 9, 2013 · 3 comments
Closed

Доработки модуля "DOC" #5

yupe opened this issue Apr 9, 2013 · 3 comments

Comments

@yupe
Copy link
Owner

yupe commented Apr 9, 2013

Парни, привет!

Смотрите, что нам необходимо. Если кратко - нам нужно повторить модуль для документации, который используется на yiiframework.ru

Общие особенности:
1 Структура каталога с доками https://github.com/yiisoft/yii/tree/master/docs
2 Возможность вести доки на N-языках (деление по каталогам en, ru и т.д.)
3 Урл для прочтения доки примерно вот такой http://yiiframework.ru/doc/guide/ru/index (отображается вот этот файл https://github.com/yiisoft/yii/blob/master/docs/guide/ru/index.txt)
4 Сами файлы документации могут быть в 2-х формтах - MarkDown (расширение .md) и HTML (.html)

Требования к модулю:
1 В модуле должна быть переменная указывающая на корневую папку с доками
2 Должен быть контроллер который будет обработывать урл-ы типа http://yupe.ru/doc/guide/ru/index
Здесь doc - модуль, guide - каталог внутри основного каталога с доками, ru - язык (по сути тоже каталог), index - файл документации
3 Доки в фомате маркдаун должны кешироваться дабы каждый раз не рендерить его в html

@yupe
Copy link
Owner Author

yupe commented Apr 9, 2013

Еще неплохо бы сам модуль переименовать в doc, "documentation" - Очень уж длинно =)

@im-kulikov
Copy link
Contributor

в doc, "documentation" - Очень уж длинно =)

поддерживаю =)
даёшь обрезание имён модулей =)

@im-kulikov
Copy link
Contributor

Уже реализовано, закрываю

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants