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

Как начать с проектной документации с использованием языка разметки maven и markdown? По умолчанию сайт Maven является APT, что неудобно, чтобы узнать, как это сделать. (Обычно никто в команде не начнет писать документацию на сайте maven, когда им также необходимо изучить еще один язык разметки на этом пути.)Как использовать уценку для сайта проекта maven?

Кто-нибудь пытался использовать уценку (тот же язык разметки, что и на github) для Maven документация проекта сайта? Я вижу от Maven Doxia references, что это возможно. Есть вопросы?

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

UPDATE. Преемник. См. Ответ ниже.

источник

2013-02-12 Paul Verest

Пока нет. Я планировал сделать это до конца февраля. Я напишу свой собственный ответ здесь, если никто не ответит. –

Ссылка, которую вы разместили, содержит всю необходимую информацию. Я постараюсь, чтобы этот вопрос был закрыт в среднем. Отправьте сообщение, если у вас есть более конкретный вопрос, когда вы пытаетесь создать документацию с помощью md. – Augusto

В Maven по умолчанию используется формат oder xdoc ... в настоящее время нет никакого maven-плагина для обработки GitHub Markdown. – khmarbaise

Цитата http://maven.apache.org/doxia/references/index.html

Добавить это pom.xml

  <plugin>  
       <groupId>org.apache.maven.plugins</groupId> 
       <artifactId>maven-site-plugin</artifactId> 
       <version>3.2</version> 
       <dependencies> 
       <dependency> 
        <groupId>org.apache.maven.doxia</groupId> 
        <artifactId>doxia-module-markdown</artifactId> 
        <version>1.3</version> 
       </dependency> 
       </dependencies> 
      </plugin>

Затем начните добавлять страницы под src/site/markdown/ с .md расширением. Для каждого пункта меню страницы надстройки, как в sniplet ниже:

<body> 
    <!-- http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html 
    <item collapse=.. ref=.. name=.. href="README" img=.. position=.. alt=.. border=.. width=.. height=.. target=.. title=.. > 
    --> 
    <menu name="User guide"> 
     <item href="README.html" name="README" /> 
    </menu> 

    <menu ref="reports" inherit="bottom" /> 
    </body>

чем использовать mvn site для создания сайта. Посмотрите на target/site, чтобы просмотреть результаты.

mvn site:stage -DstagingDirectory=C:\TEMP\fullsite Чтобы получить сайт с несколькими модулями проекта в одной папке.

Узнайте больше о maven-site-plugin.

Я рекомендую использовать maven-fluido-skin. Это самый новый тип, основанный на Twitter Bootstrap Добавить это site.xml

<project name="xxx"> 
    [...] 
    <skin> 
    <groupId>org.apache.maven.skins</groupId> 
    <artifactId>maven-fluido-skin</artifactId> 
    <version>1.3.0</version> 
    </skin> 
    [...] 
</project>

Смотрите также https://github.com/winterstein/Eclipse-Markdown-Editor-Plugin

источник

2013-02-12 11:25:01

Это сообщение должно быть добавлено в документацию Doxia, поскольку для тех из нас, кто не использовал Maven для управления документацией, не ясно, как это делается. Благодарю. –

Пример с открытым исходным кодом https: // github.com/Nodeclipse/nodeclipse-1/tree/master/src/site –

Запуск live http://dev.nodeclipse.com/ –

Другой стандартный способ заключается в использовании Maven сайта плагин следующим

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

источник

2015-02-04 23:53:01 EliuX

Этот подход использует преимущества фильтров двигателя скорости, которые плагин сайта делает http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html#Filtering. По-видимому, ваша уценка может ссылаться на переменные maven, такие как $ {project.name} – xverges

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

ответ

Смежные вопросы