001package org.apache.maven.doxia.module.markdown;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.maven.doxia.module.site.AbstractSiteModule;
023import org.apache.maven.doxia.module.site.SiteModule;
024import org.codehaus.plexus.component.annotations.Component;
025
026/**
027 * {@link org.apache.maven.doxia.module.site.SiteModule} for Markdown.
028 *
029 * @author Julien Nicoulaud <julien.nicoulaud@gmail.com>
030 * @since 1.3
031 */
032@Component( role = SiteModule.class, hint = "markdown" )
033public class MarkdownSiteModule
034    extends AbstractSiteModule
035{
036
037    /**
038     * The source directory for Markdown files.
039     */
040    public static final String SOURCE_DIRECTORY = "markdown";
041
042    /**
043     * The extension for Markdown files.
044     */
045    public static final String FILE_EXTENSION = "md";
046
047    /**
048     * Build a new instance of {@link MarkdownSiteModule}.
049     */
050    public MarkdownSiteModule()
051    {
052        super( SOURCE_DIRECTORY, FILE_EXTENSION, MarkdownParser.ROLE_HINT );
053    }
054}