diff --git a/artwork/logo-only-36.svg b/artwork/logo-only-36.svg new file mode 100644 index 00000000..cfc22dc0 --- /dev/null +++ b/artwork/logo-only-36.svg @@ -0,0 +1,129 @@ + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + diff --git a/artwork/search.svg b/artwork/search.svg new file mode 100644 index 00000000..9a620ee3 --- /dev/null +++ b/artwork/search.svg @@ -0,0 +1,159 @@ + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + diff --git a/artwork/stow.svg b/artwork/stow.svg new file mode 100644 index 00000000..d53b8cb9 --- /dev/null +++ b/artwork/stow.svg @@ -0,0 +1,161 @@ + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/artwork/tag.svg b/artwork/tag.svg new file mode 100644 index 00000000..3809c0dc --- /dev/null +++ b/artwork/tag.svg @@ -0,0 +1,90 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + diff --git a/build.sbt b/build.sbt index 42415808..4e9737e8 100644 --- a/build.sbt +++ b/build.sbt @@ -3,6 +3,7 @@ import scala.sys.process._ import com.typesafe.sbt.SbtGit.GitKeys._ import docspell.build._ + val elmCompileMode = settingKey[ElmCompileMode]("How to compile elm sources") val sharedSettings = Seq( @@ -282,14 +283,11 @@ val restserver = project.in(file("modules/restserver")). val microsite = project.in(file("modules/microsite")). enablePlugins(MicrositesPlugin). + disablePlugins(ReleasePlugin). settings(sharedSettings). settings( name := "docspell-microsite", publishArtifact := false, - scalacOptions -= "-Yno-imports", - scalacOptions ~= { _ filterNot (_ startsWith "-Ywarn") }, - scalacOptions ~= { _ filterNot (_ startsWith "-Xlint") }, - scalaVersion := "2.12.10", skip in publish := true, micrositeFooterText := Some( """ @@ -297,27 +295,24 @@ val microsite = project.in(file("modules/microsite")). |""".stripMargin ), micrositeName := "Docspell", - micrositeDescription := "Docspell – A Document Organizer", + micrositeDescription := "A (PDF) Document Organizer", + micrositeDocumentationUrl := "/docspell/getit.html", + micrositeDocumentationLabelDescription := "Download", + micrositeFavicons := Seq(microsites.MicrositeFavicon("favicon.png", "96x96")), micrositeBaseUrl := "/docspell", micrositeAuthor := "eikek", micrositeGithubOwner := "eikek", micrositeGithubRepo := "docspell", micrositeGitterChannel := false, - micrositeFavicons := Seq(microsites.MicrositeFavicon("favicon.png", "96x96")), micrositeShareOnSocial := false, micrositeHighlightLanguages ++= Seq("json", "javascript"), - micrositePalette := Map( - "brand-primary" -> "#5d000a", // link color - "brand-secondary" -> "#172651", //sidebar background - "brand-tertiary" -> "#495680", //main brand background - "gray-dark" -> "#050913", //header font color - "gray" -> "#131f43", //font color - "gray-light" -> "#E3E2E3", - "gray-lighter" -> "#f8fbff", //body background - "white-color" -> "#FFFFFF"), - fork in tut := true, - scalacOptions in Tut ~= (_.filterNot(Set("-Ywarn-unused-import", "-Ywarn-dead-code", "-Werror"))), - resourceGenerators in Tut += Def.task { + micrositeEditButton := Some(microsites.MicrositeEditButton("Improve this page", "/edit/master/modules/microsite/docs/{{ page.path }}")), + fork in run := true, + micrositeCompilingDocsTool := WithMdoc, + mdocVariables := Map( + "VERSION" -> version.value + ), + Compile/resourceGenerators += Def.task { val conf1 = (resourceDirectory in (restserver, Compile)).value / "reference.conf" val conf2 = (resourceDirectory in (joex, Compile)).value / "reference.conf" val out1 = resourceManaged.value/"main"/"jekyll"/"_includes"/"server.conf" @@ -334,14 +329,12 @@ val microsite = project.in(file("modules/microsite")). IO.copy(Seq(oa1 -> oaout)) Seq(out1, out2, oaout) }.taskValue, - resourceGenerators in Tut += Def.task { + Compile/resourceGenerators += Def.task { val staticDoc = (restapi/Compile/openapiStaticDoc).value val target = resourceManaged.value/"main"/"jekyll"/"openapi"/"docspell-openapi.html" IO.copy(Seq(staticDoc -> target)) Seq(target) - }.taskValue, - micrositeCompilingDocsTool := WithTut //WithMdoc -// mdocIn := sourceDirectory.value / "main" / "tut" + }.taskValue ) val root = project.in(file(".")). @@ -357,8 +350,7 @@ val root = project.in(file(".")). , backend , webapp , restapi - , restserver - , microsite) + , restserver) diff --git a/modules/microsite/src/main/tut/api.md b/modules/microsite/docs/api.md similarity index 99% rename from modules/microsite/src/main/tut/api.md rename to modules/microsite/docs/api.md index bc9a2511..25392e6d 100644 --- a/modules/microsite/src/main/tut/api.md +++ b/modules/microsite/docs/api.md @@ -1,6 +1,5 @@ --- layout: docs -position: 5 title: Api --- diff --git a/modules/microsite/docs/demo.md b/modules/microsite/docs/demo.md new file mode 100644 index 00000000..42a59524 --- /dev/null +++ b/modules/microsite/docs/demo.md @@ -0,0 +1,10 @@ +--- +layout: docs +title: Demo +--- + +# {{ page.title }} + + + + diff --git a/modules/microsite/src/main/tut/dev.md b/modules/microsite/docs/dev.md similarity index 100% rename from modules/microsite/src/main/tut/dev.md rename to modules/microsite/docs/dev.md diff --git a/modules/microsite/src/main/tut/dev/adr.md b/modules/microsite/docs/dev/adr.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr.md rename to modules/microsite/docs/dev/adr.md diff --git a/modules/microsite/src/main/tut/dev/adr/0000_use_markdown_architectural_decision_records.md b/modules/microsite/docs/dev/adr/0000_use_markdown_architectural_decision_records.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/0000_use_markdown_architectural_decision_records.md rename to modules/microsite/docs/dev/adr/0000_use_markdown_architectural_decision_records.md diff --git a/modules/microsite/src/main/tut/dev/adr/0001_components.md b/modules/microsite/docs/dev/adr/0001_components.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/0001_components.md rename to modules/microsite/docs/dev/adr/0001_components.md diff --git a/modules/microsite/src/main/tut/dev/adr/0002_component_interaction.md b/modules/microsite/docs/dev/adr/0002_component_interaction.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/0002_component_interaction.md rename to modules/microsite/docs/dev/adr/0002_component_interaction.md diff --git a/modules/microsite/src/main/tut/dev/adr/0003_encryption.md b/modules/microsite/docs/dev/adr/0003_encryption.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/0003_encryption.md rename to modules/microsite/docs/dev/adr/0003_encryption.md diff --git a/modules/microsite/src/main/tut/dev/adr/0004_iso8601vsEpoch.md b/modules/microsite/docs/dev/adr/0004_iso8601vsEpoch.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/0004_iso8601vsEpoch.md rename to modules/microsite/docs/dev/adr/0004_iso8601vsEpoch.md diff --git a/modules/microsite/src/main/tut/dev/adr/0005_job-executor.md b/modules/microsite/docs/dev/adr/0005_job-executor.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/0005_job-executor.md rename to modules/microsite/docs/dev/adr/0005_job-executor.md diff --git a/modules/microsite/src/main/tut/dev/adr/template.md b/modules/microsite/docs/dev/adr/template.md similarity index 100% rename from modules/microsite/src/main/tut/dev/adr/template.md rename to modules/microsite/docs/dev/adr/template.md diff --git a/modules/microsite/src/main/tut/doc.md b/modules/microsite/docs/doc.md similarity index 100% rename from modules/microsite/src/main/tut/doc.md rename to modules/microsite/docs/doc.md diff --git a/modules/microsite/src/main/tut/doc/configure.md b/modules/microsite/docs/doc/configure.md similarity index 100% rename from modules/microsite/src/main/tut/doc/configure.md rename to modules/microsite/docs/doc/configure.md diff --git a/modules/microsite/src/main/tut/doc/curate.md b/modules/microsite/docs/doc/curate.md similarity index 100% rename from modules/microsite/src/main/tut/doc/curate.md rename to modules/microsite/docs/doc/curate.md diff --git a/modules/microsite/src/main/tut/doc/install.md b/modules/microsite/docs/doc/install.md similarity index 100% rename from modules/microsite/src/main/tut/doc/install.md rename to modules/microsite/docs/doc/install.md diff --git a/modules/microsite/src/main/tut/doc/joex.md b/modules/microsite/docs/doc/joex.md similarity index 100% rename from modules/microsite/src/main/tut/doc/joex.md rename to modules/microsite/docs/doc/joex.md diff --git a/modules/microsite/src/main/tut/doc/metadata.md b/modules/microsite/docs/doc/metadata.md similarity index 100% rename from modules/microsite/src/main/tut/doc/metadata.md rename to modules/microsite/docs/doc/metadata.md diff --git a/modules/microsite/src/main/tut/doc/processing.md b/modules/microsite/docs/doc/processing.md similarity index 100% rename from modules/microsite/src/main/tut/doc/processing.md rename to modules/microsite/docs/doc/processing.md diff --git a/modules/microsite/src/main/tut/doc/tools.md b/modules/microsite/docs/doc/tools.md similarity index 100% rename from modules/microsite/src/main/tut/doc/tools.md rename to modules/microsite/docs/doc/tools.md diff --git a/modules/microsite/src/main/tut/doc/uploading.md b/modules/microsite/docs/doc/uploading.md similarity index 100% rename from modules/microsite/src/main/tut/doc/uploading.md rename to modules/microsite/docs/doc/uploading.md diff --git a/modules/microsite/src/main/tut/getit.md b/modules/microsite/docs/getit.md similarity index 82% rename from modules/microsite/src/main/tut/getit.md rename to modules/microsite/docs/getit.md index b268963c..c8eefcbb 100644 --- a/modules/microsite/src/main/tut/getit.md +++ b/modules/microsite/docs/getit.md @@ -1,12 +1,6 @@ --- -layout: home -position: 3 -section: quickstart +layout: docs title: Quickstart -technologies: - - first: ["Scala + Elm", "Backend is in Scala with Cats/Fs2, Webapp in Elm"] - - second: ["Unpaper + Tesseract", "Text is extracted using OCR provided by tesseract"] - - third: ["Stanford NLP", "Documents are analyzed using Stanford NLP classifiers"] --- ## Download diff --git a/modules/microsite/src/main/tut/index.md b/modules/microsite/docs/index.md similarity index 72% rename from modules/microsite/src/main/tut/index.md rename to modules/microsite/docs/index.md index 6225ccfa..19ca5afc 100644 --- a/modules/microsite/src/main/tut/index.md +++ b/modules/microsite/docs/index.md @@ -1,12 +1,9 @@ --- -layout: home -position: 1 -section: home -title: Home -technologies: - - first: ["Scala + Elm", "Backend is in Scala with Cats/Fs2, Webapp in Elm"] - - second: ["Unpaper + Tesseract", "Text is extracted using OCR provided by tesseract"] - - third: ["Stanford NLP", "Documents are analyzed using Stanford NLP classifiers"] +layout: homeFeatures +features: + - first: ["Stow documents away", "Most of the time documents (emails, postal mail) are received or created. It should be fast to stow them away, knowing that they can be found if necessary."] + - second: ["Semi-Automatic Tagging", "Documents are analyzed and tagged automatically. “Semi–”, because it may not always be correct; results can be reviewed and corrected."] + - third: ["Find them", "If there is a document needed, you can search for it. Usually, restricting to a date range and a correspondent will result in only a few documents to sift through. Alternatively, you can add your own tags, names etc to better match your workflow."] --- # A Document Organizer diff --git a/modules/microsite/src/main/resources/microsite/css/docspell.css b/modules/microsite/src/main/resources/microsite/css/docspell.css index 3c1c8e2f..9b33b9bb 100644 --- a/modules/microsite/src/main/resources/microsite/css/docspell.css +++ b/modules/microsite/src/main/resources/microsite/css/docspell.css @@ -1,18 +1,27 @@ -.jumbotron { +#masthead { background: url(../img/back-master-small.jpg); background-repeat: no-repeat; background-size: 100% 800px; } -.content-wrapper h1, .h1 { - border-bottom: 1px solid #d8dfe5; - padding-bottom: 0.8rem; +.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open>a, .docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item.open button { + background: #495680; +} +.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item .sub-section { + background: #172651; +} +.docs #sidebar-wrapper .sidebar-nav .sidebar-nav-item .sub-section a.active { + font-weight: bold; +} +.docs #sidebar-wrapper { + background: #172651; } -body { - font-size: 1.75em; +.docs #sidebar-wrapper #sidebar-brand { + background: #495680; + } -h4 { +.docs h4 { text-decoration: underline; } diff --git a/modules/microsite/src/main/resources/microsite/data/menu.yml b/modules/microsite/src/main/resources/microsite/data/menu.yml index e4363d57..9b609694 100644 --- a/modules/microsite/src/main/resources/microsite/data/menu.yml +++ b/modules/microsite/src/main/resources/microsite/data/menu.yml @@ -2,7 +2,10 @@ options: - title: Home url: index.html - - title: Getit + - title: Demo + url: demo.html + + - title: Quickstart url: getit.html - title: Documentation diff --git a/modules/microsite/src/main/resources/microsite/img/features-header.svg b/modules/microsite/src/main/resources/microsite/img/features-header.svg new file mode 120000 index 00000000..75fe7ef4 --- /dev/null +++ b/modules/microsite/src/main/resources/microsite/img/features-header.svg @@ -0,0 +1 @@ +../../../../../../../artwork/logo-only.svg \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/first-feature-icon.svg b/modules/microsite/src/main/resources/microsite/img/first-feature-icon.svg new file mode 120000 index 00000000..7d6f35b8 --- /dev/null +++ b/modules/microsite/src/main/resources/microsite/img/first-feature-icon.svg @@ -0,0 +1 @@ +../../../../../../../artwork/stow.svg \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/light-navbar-brand.svg b/modules/microsite/src/main/resources/microsite/img/light-navbar-brand.svg new file mode 120000 index 00000000..76d21b70 --- /dev/null +++ b/modules/microsite/src/main/resources/microsite/img/light-navbar-brand.svg @@ -0,0 +1 @@ +../../../../../../../artwork/logo-only-36.svg \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/light-sidebar-brand.svg b/modules/microsite/src/main/resources/microsite/img/light-sidebar-brand.svg new file mode 120000 index 00000000..15434edc --- /dev/null +++ b/modules/microsite/src/main/resources/microsite/img/light-sidebar-brand.svg @@ -0,0 +1 @@ +light-navbar-brand.svg \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/navbar_brand.png b/modules/microsite/src/main/resources/microsite/img/navbar_brand.png deleted file mode 120000 index 713c4fb8..00000000 --- a/modules/microsite/src/main/resources/microsite/img/navbar_brand.png +++ /dev/null @@ -1 +0,0 @@ -../../../../../../../artwork/logo-96.png \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/navbar_brand2x.png b/modules/microsite/src/main/resources/microsite/img/navbar_brand2x.png deleted file mode 120000 index 713c4fb8..00000000 --- a/modules/microsite/src/main/resources/microsite/img/navbar_brand2x.png +++ /dev/null @@ -1 +0,0 @@ -../../../../../../../artwork/logo-96.png \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/second-feature-icon.svg b/modules/microsite/src/main/resources/microsite/img/second-feature-icon.svg new file mode 120000 index 00000000..52db5991 --- /dev/null +++ b/modules/microsite/src/main/resources/microsite/img/second-feature-icon.svg @@ -0,0 +1 @@ +../../../../../../../artwork/tag.svg \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/sidebar_brand.png b/modules/microsite/src/main/resources/microsite/img/sidebar_brand.png deleted file mode 120000 index 713c4fb8..00000000 --- a/modules/microsite/src/main/resources/microsite/img/sidebar_brand.png +++ /dev/null @@ -1 +0,0 @@ -../../../../../../../artwork/logo-96.png \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/sidebar_brand2x.png b/modules/microsite/src/main/resources/microsite/img/sidebar_brand2x.png deleted file mode 120000 index 713c4fb8..00000000 --- a/modules/microsite/src/main/resources/microsite/img/sidebar_brand2x.png +++ /dev/null @@ -1 +0,0 @@ -../../../../../../../artwork/logo-96.png \ No newline at end of file diff --git a/modules/microsite/src/main/resources/microsite/img/third-feature-icon.svg b/modules/microsite/src/main/resources/microsite/img/third-feature-icon.svg new file mode 120000 index 00000000..89be9542 --- /dev/null +++ b/modules/microsite/src/main/resources/microsite/img/third-feature-icon.svg @@ -0,0 +1 @@ +../../../../../../../artwork/search.svg \ No newline at end of file diff --git a/modules/microsite/src/main/tut/demo.md b/modules/microsite/src/main/tut/demo.md deleted file mode 100644 index 3568f211..00000000 --- a/modules/microsite/src/main/tut/demo.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: home -position: 2 -section: demo -title: Demo -technologies: - - first: ["Scala + Elm", "Backend is in Scala with Cats/Fs2, Webapp in Elm"] - - second: ["Unpaper + Tesseract", "Text is extracted using OCR provided by tesseract"] - - third: ["Stanford NLP", "Documents are analyzed using Stanford NLP classifiers"] ---- - -# {{ page.title }} - - - - diff --git a/modules/webapp/src/main/webjar/docspell.css b/modules/webapp/src/main/webjar/docspell.css index 45e6ac0d..9a57643d 100644 --- a/modules/webapp/src/main/webjar/docspell.css +++ b/modules/webapp/src/main/webjar/docspell.css @@ -99,7 +99,7 @@ span.small-info { .login-layout .login-view, .register-layout .register-view, .newinvite-view { background: #fff; position: relative; - top: 20vh; + top: 2vh; } .invisible { diff --git a/project/plugins.sbt b/project/plugins.sbt index 2f59529d..d852e942 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -1,4 +1,4 @@ -addSbtPlugin("com.47deg" % "sbt-microsites" % "0.9.2") +addSbtPlugin("com.47deg" % "sbt-microsites" % "1.0.2") addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.9.0") addSbtPlugin("com.github.eikek" % "sbt-openapi-schema" % "0.5.0") addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.12")