This project has been folded into the main Orchid project, and will be maintained there rather than here!
An sbt plugin for the Orchid static site generator.
Orchid is a JVM-hosted static-site generator. It's basic work is to take a bunch and wide variety of source files and convert them into a static website.
Following sbt-ish conventions, sbt-orchid by default looks for source files in src/main/orchid of your project,
and delivers a site to target/orchid.
For information about what the source directory should contain, it's best to go through the Orchid tutorials (source repository here).
Note: The gradle-project directory src/orchid/resources referred to in the tutorials becomes src/main/orchid (with no "resources" directory) under this sbt plugin.
If you don't like this choice, you can define any source directory you'd like for your Orchid site via the setting orchidSource.
Once you have placed your files in src/main/orchid, the usual workflow will be via the task orchidServe, which builds the site
and starts an internal webserver on localhost to view it (on port 8080, so http://localhost:8080, by default).
sbt:orchid-play> orchidServe
Using the following modules:
--------------------
* com.eden.orchid.StandardModule
Auto-loaded modules:
--------------------
* com.eden.orchid.bsdoc.BsDocModule
* com.eden.orchid.impl.compilers.markdown.FlexmarkModule
* com.eden.orchid.impl.compilers.pebble.PebbleModule
...
Webserver Running at http://localhost:8080
Hit [CTRL-C] to stop the server and quit Orchid
To just ensure that the site gets built without pausing to browse with a webserver, use orchidBuild instead of orchidServe.
In build.sbt, you will usually want to define a theme. For example...
orchidTheme := "BsDoc"
Make sure the theme is available, see Setup below for how to bring in components.
For less commonly used confiuration settings, see the Appendix.
As is common for sbt plugins, you will usually want to install this plugin by adding it to project/plugins.sbt in your
repository.
However, adding the plugin alone is not usually sufficient to get a workable installation. Orchid is configured in large part
by dynamically loading a variety of themes and plugins, which you will want to add to the libraryDependencies of your build, not your project.
An easy, clean way to deal with that is just to add these extra dependencies in your project/plugins.sbt file:
resolvers += Resolver.jcenterRepo // hosts Orchid and its components
addSbtPlugin("com.mchange" % "sbt-orchid" % "0.0.1")
/*
* Add desired Orchid components to the build
*/
val OrchidVersion = "0.17.6"
def orchidComponent( name : String ) = "io.github.javaeden.orchid" % name % OrchidVersion
/*
* The plugin includes OrchidCore already as a dependency,
* but explicitly specifying it endures version consistency.
*/
libraryDependencies += orchidComponent( "OrchidCore" )
/*
* Uncomment the components you desire
*/
/* Themes -- see https://orchid.netlify.com/themes */
/* Don't forget to set 'orchidTheme' in build.sbt! */
// libraryDependencies += orchidComponent( "OrchidBsDoc" )
// libraryDependencies += orchidComponent( "OrchidCopper" )
// libraryDependencies += orchidComponent( "OrchidEditorial" )
// libraryDependencies += orchidComponent( "OrchidFutureImperfect" )
/* Plugins -- see https://orchid.netlify.com/plugins */
// libraryDependencies += orchidComponent( "OrchidPages" )
// libraryDependencies += orchidComponent( "OrchidPosts" )
// libraryDependencies += orchidComponent( "OrchidPluginDocs" )
// libraryDependencies += orchidComponent( "OrchidAsciidoc" )
// libraryDependencies += orchidComponent( "OrchidAzure" )
// libraryDependencies += orchidComponent( "OrchidBible" )
// libraryDependencies += orchidComponent( "OrchidBitbucket" )
// libraryDependencies += orchidComponent( "OrchidChangelog" )
// libraryDependencies += orchidComponent( "OrchidDiagrams" )
// libraryDependencies += orchidComponent( "OrchidForms" )
// libraryDependencies += orchidComponent( "OrchidGithub" )
// libraryDependencies += orchidComponent( "OrchidGitlab" )
// libraryDependencies += orchidComponent( "OrchidGroovydoc" )
// libraryDependencies += orchidComponent( "OrchidJavadoc" )
// libraryDependencies += orchidComponent( "OrchidKSS" )
// libraryDependencies += orchidComponent( "OrchidKotlindoc" )
// libraryDependencies += orchidComponent( "OrchidNetlify" )
// libraryDependencies += orchidComponent( "OrchidNetlifyCMS" )
// libraryDependencies += orchidComponent( "OrchidPresentations" )
// libraryDependencies += orchidComponent( "OrchidSearch" )
// libraryDependencies += orchidComponent( "OrchidSwagger" )
// libraryDependencies += orchidComponent( "OrchidSwiftdoc" )
// libraryDependencies += orchidComponent( "OrchidSyntaxHighlighter" )
// libraryDependencies += orchidComponent( "OrchidTaxonomies" )
// libraryDependencies += orchidComponent( "OrchidWiki" )
// libraryDependencies += orchidComponent( "OrchidWritersBlocks" )
orchidBaseUrl~ The base URL for generted site linksorchidDestination~ The directory into which orchid sites are generatedorchidDryDeploy~ Allows running a dry deploy instead of a full deployorchidEnvironment~ The environment used to run the orchid site.orchidPort~ The port to run the dev server on.orchidSource~ The source directory for orchid documentsorchidTheme~ The theme that will be imposed on the generated orchid siteorchidVersion~ The version of the orchid site