Документация для проекта Java (уценка)
У меня довольно стандартный проект Java со стандартным макетом Gradle, все исходники хранятся в Git. Я хочу написать документацию на уценке (или аналогичном языке разметки) и сохранить все файлы в каталоге проекта (например, в папке docs/ в корне). Затем я хочу создать статический сайт или отправить куда-нибудь свои источники, чтобы получить доступ к полной документации в формате html (должно быть самостоятельным решением).
Будет хорошо, если я смогу добавить простую ссылку на другие статьи (как я делаю это в любом вики-движке, используя [[article]]). И было бы замечательно, если бы я смог добавить быстрые ссылки на Javadoc по той же методике, что и ссылки на статьи. А также было бы идеально, если бы у него была встроенная поисковая система.
Я прошел через пару статических генераторов сайтов, но я не нашел ничего, что могло бы удовлетворить мои требования хотя бы наполовину. Есть ли что-то подобное? Или мне нужно кодировать его самостоятельно (я знаю, что это не займет много времени)? Может быть, есть более распространенный вариант использования документации?
1 ответ
Вы должны использовать концепцию доклетов. Там есть некоторые. Может быть, просто попробуйте это: