Задать вопрос
mknk
@mknk
Разработчик 1С-Битрикс

Какой есть инструмент для формирования и централизованного хранения документации по исходному коду?

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

На текущий момент документацию формируем через PhpDocumentor и храним ее рядом с исходниками. Такой вариант уже не очень подходит.

Нюанс в том, что система должна работать локально без доступа во вне.

Кто сталкивался с такой или похожей задачей? Может есть на просторах толковый инструмент?
  • Вопрос задан
  • 238 просмотров
Подписаться 1 Простой 1 комментарий
Пригласить эксперта
Ответы на вопрос 2
zkrvndm
@zkrvndm
Архитектор решений
Пилите сайт, хоть на том же Битриксе и размещайте его локально. Можно даже на флешку записать при желании и потом всегда носить с собой:
https://usbwebserver.yura.mk.ua/ru.php
Ответ написан
@Stalinko
PHP'шник и фрилансер до мозга костей
Советую посмотреть в сторону Swagger и ReDoc.

Если кратко:

всю документацию пишешь в одном json-файле в формате Swagger-OpenAPI.
Затем пишешь коротенькую html, которая подцепляет ReDoc и скармилвает ему твой json. Далее это всё превращается в красивые доки. Пример html:

<!DOCTYPE html>
<html lang="en">
<head>
    <title>My API</title>
    <meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="robots" content="noindex,nofollow" />
    <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
    <style>
        body {
            margin: 0;
            padding: 0;
        }
    </style>
</head>
<body>
<script>
    <redoc spec-url="my-api.json"></redoc>
</script>
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
</body>
</html>
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы