aboutsummaryrefslogtreecommitdiff
path: root/subprojects/analysis-markdown-jb/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'subprojects/analysis-markdown-jb/README.md')
-rw-r--r--subprojects/analysis-markdown-jb/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/subprojects/analysis-markdown-jb/README.md b/subprojects/analysis-markdown-jb/README.md
new file mode 100644
index 00000000..2922abc8
--- /dev/null
+++ b/subprojects/analysis-markdown-jb/README.md
@@ -0,0 +1,7 @@
+# Ananlysis: Markdown (JetBrains)
+
+An internal module that encapsulates Markdown file and format parsing by using `org.jetbrains:markdown`
+as the primary implementation dependency.
+
+Used by other Dokka modules, but it must not be used by external users directly until stable public API
+is provided.