Document internals, and build docs

Author: tecosaur

docs/Project.toml

@@ -0,0 +1,3 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+StyledStrings = "f489334b-da3d-4c2e-b8f0-e476e12c162b"

docs/make.jl

@@ -0,0 +1,20 @@
+using JuliaSyntaxHighlighting
+using Documenter
+
+DocMeta.setdocmeta!(JuliaSyntaxHighlighting, :DocTestSetup, :(using JuliaSyntaxHighlighting); recursive=true)
+
+makedocs(;
+    modules = [JuliaSyntaxHighlighting],
+    sitename = "Julia Syntax Highlighting",
+    authors = "tecosaur <[email protected]> and contributors",
+    repo = "https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl/blob/{commit}{path}#{line}",
+    format = Documenter.HTML(ansicolor = true),
+    pages = [
+        "JuliaSyntaxHighlighting" => "index.md",
+        "Internals" => "internals.md",
+    ],
+    warnonly = [:cross_references],
+)
+
+deploydocs(repo="github.com/JuliaLang/JuliaSyntaxHighlighting.jl",
+           push_preview = true)

docs/src/internals.md

@@ -0,0 +1,18 @@
+# Internals
+
+Everything documented in this page is internal and subject to breaking changes.
+These are provided here for those curious about how `JuliaSyntaxHighlighting`
+works, and as a reference for contributors.
+
+```@docs
+JuliaSyntaxHighlighting.MAX_PAREN_HIGHLIGHT_DEPTH
+JuliaSyntaxHighlighting.RAINBOW_DELIMITERS_ENABLED
+JuliaSyntaxHighlighting.UNMATCHED_DELIMITERS_ENABLED
+JuliaSyntaxHighlighting.SINGLETON_IDENTIFIERS
+JuliaSyntaxHighlighting.BASE_TYPE_IDENTIFIERS
+JuliaSyntaxHighlighting.BUILTIN_FUNCTIONS
+JuliaSyntaxHighlighting.HIGHLIGHT_FACES
+JuliaSyntaxHighlighting.paren_type
+JuliaSyntaxHighlighting._hl_annotations
+JuliaSyntaxHighlighting._hl_annotations!
+```