uschindler commented on a change in pull request #1477: URL: https://github.com/apache/lucene-solr/pull/1477#discussion_r425769125
########## File path: gradle/documentation/markdown.gradle ########## @@ -0,0 +1,172 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import com.vladsch.flexmark.ast.Heading; +import com.vladsch.flexmark.ext.abbreviation.AbbreviationExtension; +import com.vladsch.flexmark.ext.attributes.AttributesExtension; +import com.vladsch.flexmark.ext.autolink.AutolinkExtension; +import com.vladsch.flexmark.html.HtmlRenderer; +import com.vladsch.flexmark.parser.Parser; +import com.vladsch.flexmark.parser.ParserEmulationProfile; +import com.vladsch.flexmark.util.ast.Document; +import com.vladsch.flexmark.util.data.MutableDataSet; +import com.vladsch.flexmark.util.sequence.Escaping; +import groovy.text.SimpleTemplateEngine; + +buildscript { + repositories { + mavenCentral() + } + + dependencies { + classpath "com.vladsch.flexmark:flexmark:${scriptDepVersions['flexmark']}" + classpath "com.vladsch.flexmark:flexmark-ext-abbreviation:${scriptDepVersions['flexmark']}" + classpath "com.vladsch.flexmark:flexmark-ext-attributes:${scriptDepVersions['flexmark']}" + classpath "com.vladsch.flexmark:flexmark-ext-autolink:${scriptDepVersions['flexmark']}" + } +} + +def getListOfProjectsAsMarkdown = { prefix -> + def projects = allprojects.findAll{ it.path.startsWith(prefix) && it.tasks.findByName('renderSiteJavadoc') } + .sort(false, Comparator.comparing{ (it.name != 'core') as Boolean } + .thenComparing(Comparator.comparing{ (it.name == 'test-framework') as Boolean }) + .thenComparing(Comparator.comparing{ it.path })); + return projects.collect{ project -> + def text = "**[${project.path.substring(prefix.length()).replace(':','-')}](${project.relativeDocPath}/index.html):** ${project.description}" + if (project.name == 'core') { + text = text.concat(' {style="font-size:larger; margin-bottom:.5em"}') + } + return '* ' + text; + }.join('\n') +} + +configure(subprojects.findAll { it.path == ':lucene' || it.path == ':solr' }) { + task markdownToHtml(type: Copy) { + filteringCharset = 'UTF-8' + includeEmptyDirs = false + into project.docroot + rename(/\.md$/, '.html') + filter(MarkdownFilter) + } +} + +configure(project(':lucene')) { + markdownToHtml { + from('.') { + include 'MIGRATE.md' + include 'JRE_VERSION_MIGRATION.md' + include 'SYSTEM_REQUIREMENTS.md' + } + } + + task createDocumentationIndex(type: MarkdownTemplateTask) { + def defaultCodecFile = project(':lucene:core').file('src/java/org/apache/lucene/codecs/Codec.java') + inputs.file(defaultCodecFile) + + outputFile = file("${project.docroot}/index.html") + templateFile = file('site/xsl/index.template.md') + + binding = { + // static Codec defaultCodec = LOADER . lookup ( "LuceneXXX" ) ; + def regex = ~/\bdefaultCodec\s*=\s*LOADER\s*\.\s*lookup\s*\(\s*"([^"]+)"\s*\)\s*;/ + def matcher = regex.matcher(defaultCodecFile.getText('UTF-8')) + if (!matcher.find()) { + throw GradleException("Cannot determine default codec from file ${defaultCodecFile}") + } + def majorVersion = project.version.split(/\./)[0] as int; + return [ + defaultCodecPackage : matcher.group(1).toLowerCase(Locale.ROOT), + version : project.version, + majorVersion : majorVersion, + projectList : getListOfProjectsAsMarkdown(':lucene:') + ] + } + } +} + +configure(project(':solr')) { + markdownToHtml { + from('site') { + include '**/*.md' + } + } + + task createDocumentationIndex { + // nocommit: this needs to be implemented next + } +} + +// filter that can be used with the "copy" task of Gradle that transforms Markdown files +// from source location to HTML (adding HTML header, styling,...) +class MarkdownFilter extends FilterReader { + + public MarkdownFilter(Reader reader) throws IOException { + // this is not really a filter: it reads whole file in ctor, + // converts it and provides result downstream as a StringReader + super(new StringReader(convert(reader.text))); + } + + public static String convert(String markdownSource) { + // first replace LUCENE and SOLR issue numbers with a markdown link + markdownSource = markdownSource.replaceAll(/(?s)\b(LUCENE|SOLR)\-\d+\b/, + '[$0](https://issues.apache.org/jira/browse/$0)'); + + // convert the markdown + MutableDataSet options = new MutableDataSet(); + options.setFrom(ParserEmulationProfile.MARKDOWN); + options.set(Parser.EXTENSIONS, [ AbbreviationExtension.create(), AutolinkExtension.create(), AttributesExtension.create() ]); + options.set(HtmlRenderer.RENDER_HEADER_ID, true); + options.set(HtmlRenderer.MAX_TRAILING_BLANK_LINES, 0); + Document parsed = Parser.builder(options).build().parse(markdownSource); + + StringBuilder html = new StringBuilder('<html>\n<head>\n'); Review comment: I would add CSS in a separate issue. I just want to get everything running first. What do you think about current state? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
