View Javadoc

1   package org.apache.maven.doxia.module.markdown;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.doxia.module.site.AbstractSiteModule;
23  import org.apache.maven.doxia.module.site.SiteModule;
24  import org.codehaus.plexus.component.annotations.Component;
25  
26  /**
27   * {@link org.apache.maven.doxia.module.site.SiteModule} for Markdown.
28   *
29   * @author Julien Nicoulaud <julien.nicoulaud@gmail.com>
30   * @since 1.3
31   */
32  @Component( role = SiteModule.class, hint = "markdown" )
33  public class MarkdownSiteModule
34      extends AbstractSiteModule
35  {
36  
37      /**
38       * The source directory for Markdown files.
39       */
40      public static final String SOURCE_DIRECTORY = "markdown";
41  
42      /**
43       * The extension for Markdown files.
44       */
45      public static final String FILE_EXTENSION = "md";
46  
47      /**
48       * Build a new instance of {@link MarkdownSiteModule}.
49       */
50      public MarkdownSiteModule()
51      {
52          super( SOURCE_DIRECTORY, FILE_EXTENSION, MarkdownParser.ROLE_HINT );
53      }
54  }