documentation is now hosted on github pages

This commit is contained in:
Athou
2025-02-23 20:22:12 +01:00
parent 1a5b932742
commit cca3c907db
5 changed files with 6 additions and 922 deletions

View File

@@ -68,7 +68,7 @@ CommaFeed also supports:
## Configuration
All [CommaFeed settings](https://github.com/Athou/commafeed/blob/master/commafeed-server/doc/commafeed.md) are
All [CommaFeed settings](https://athou.github.io/commafeed/documentation) are
optional and have sensible default values.
Settings are overrideable with environment variables. For instance, `commafeed.feed-refresh.interval-empirical` can be

View File

@@ -1,22 +0,0 @@
package com.commafeed;
import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import org.apache.commons.io.FileUtils;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
class CommaFeedConfigurationTest {
@Test
void verifyMarkdownDocIsUpToDate() throws IOException {
String versionedDocumentationFile = FileUtils.readFileToString(new File("doc/commafeed.md"), StandardCharsets.UTF_8);
String generatedDocumentationFile = FileUtils.readFileToString(new File("target/quarkus-generated-doc/config/commafeed-server.md"),
StandardCharsets.UTF_8);
Assertions.assertLinesMatch(versionedDocumentationFile.lines(), generatedDocumentationFile.lines());
}
}