DEV Community: Orchid

0.21.0 Released

Casey Brooks — Mon, 01 Jun 2020 18:47:50 +0000

Being stuck at home may not be the most exciting, but it has given me lots of time to fix bugs and make Orchid better for you! This latest release, 0.21.0, includes many bug fixes identified (and sometimes fixed!) by the community, and also boasts some significant internal changes which improve Orchid's overall performance and prepare a major portion of its functionality to be pulled into a standalone library (which you'll absolutely want to check out when it's released).

This is the official Orchid newsletter, the newest and best documentation site generator. There is a growing need to keep the community up-to-date on all the happenings around Orchid, and here I will share Orchid's progress, milestones, and future plans! Follow along with this series to stay on top of Orchid's newest features, track adoption on Github, and see who's using Orchid!

On Github

The Orchid community is growing larger all the time, and the repo is now at 367 stars!

Orchid also received contributions from Mikko Värri for improvements to sitemaps, and Javier Segovia Córdoba with documentation fixes.

And thank you to everyone else who has been giving Orchid a try, reaching out with questions and feedback, and generally supporting this growing community!

What's New?

Full release notes and a migration guide are available here. Here's a summary of what to expect in 0.21.0:

Experimental sourcedocs are now enabled by default and do not need a CLI flag to use.
Sourcedocs modules can now cross-link between each other for multi-module projects, or those with multiple interlinked sourcesets (like Kotlin MPP).
Collections have become the base unit of organizing groups of pages in Orchid, and there is now a collectionPages menu item to display pages from a collection from any plugin.
Asset management is greatly improved, and support for downloading and inlining CSS and JS assets is now available from config.yml as well as from plugin code.
Diagnostic output across the board is generally improved. Pebble templates are now more descriptive about errors with better line-number tracking (to aid in resolving specific Pebble template issues), and OrchidTest now only shows HTML selectors from the test instead of the entire rendered page.

In Progress

Continued work is underway to support relative URLs (for viewing an Orchid site without needing a local fileserver). In addition, Orchid's resource/file management is a core subsystem that would do well to be a separate library, and work is in progress to move it out of Orchid and into Arcana, it's own library. This library will be Kotlin multiplatform-enabled, bringing Orchid's simple and flexible file-management APIs to Android, iOS, JS, and of course, pure JVM.

Are you interested in getting started with Orchid? There simply is no better way to manage all the documentation for your project, and I'd love to help you get set up!

If you have an open-source project that needs docs, are building a new portfolio, or are building any other kind of static site, I want to work with you to get you set up with Orchid! Comment on this post, send me a PM here on Dev.to, reach out on Gitter, or contact me here and I will be with you every step of the way.

And as always, let me know if you start using Orchid so I can feature you in the next update!

New Snippets plugin, 0.20.0 Released

Casey Brooks — Mon, 30 Mar 2020 17:33:59 +0000

The next major version of Orchid, 0.20.0, is now available! It includes the first introduction of the long-awaited Snippets plugin, as well as a number of smaller quality-of-life improvements throughout. Check out the full release notes here, and stick around for a general update of the development and community around Orchid!

On Github

Orchid is now at 343 stars on Github, and since the last newsletter has received a PR from Bruno Vernay with some improvements to the formatting of blog post filenames.

I also want to give a special thanks to everyone who provided feedback and suggestions for the new Snippets plugin! Both on the proposal issue and on Gitter, your suggestions are what decided the features to include in this first release, and it's my hope that it will provide exactly the solution you're looking for!

And thank you to everyone else who has been giving Orchid a try, reaching out with questions and feedback, and generally supporting this growing community!

What's New?

This latest release is a continuation of the "quality-of-life" improvements that have been suggested by the you and are making Orchid better and easier to use. Some of these changes required breaking the internal API (thus the major version bump to 0.20.0), but this version does not include any deprecations or breaking changes to the public, end-user features. Below are the new features available in 0.19.0:

New Snippets plugin allows you to lookup and embed snippets from code, files, and even external webpages!
The Admin Panel layout got a minor makeover to make it easier to use and more flexible.
Forms and snippets located during the site build are care listed and can be previewed in the admin panel.
Allows Forms to be embedded with a new form tag, instead of only as Components as before.
Replaces default accordion markup with details/summary HTML5 tag for best usage in all themes
Tabbed TemplateTags can now be rendered dynamically! You can now use loops and conditionals to add individual tabs to the body of tabbed tags, instead of having to have them be statically-determined.
Both the base URL and your theme can now be set in config.yml, instead of needing to be set in your Gradle or Maven build scripts.
Improvements to base URL management now allow plugins to provide "helpers" for determining the base URL, such as OrchidNetlify detecting when Orchid is running on Netlify's CI platform and using its build environment variables to find the base URL.
OrchidPosts now relaxes slightly the strict filename requirements for post files.

Full release notes and a migration guide are available here.

In Progress

The changes allowing base URLs to be set from config.yml, instead of being a flag from the CLI or build plugins, brings us closer to having relative urls for generated links instead absolute as they are now. Relative URLs don't include a base URL, but instead provide a path from the current page to the linked one, and will make it possible to view an Orchid site directly in the filesystem instead of needing to start an HTTP server to view it.

There is still work to be done on this, but it's now considered a mid- to short-term goal for Orchid instead of a long-term one, and it will be a huge win for those of you using Orchid for documentation. Thank you to everyone who has been asking for this, I hope to be able to provide this feature for you soon!

Are you interested in getting started with Orchid? There simply is no better way to manage all the documentation for your project, and I'd love to help you get set up!

And as always, let me know if you start using Orchid so I can feature you in the next update!

0.19.0 Released

Casey Brooks — Sun, 23 Feb 2020 23:37:10 +0000

The next major version of Orchid, 0.19.0, is now available! Check out the full release notes here, and stick around for a general update of the development and community around Orchid!

On Github

Orchid is now at 329 stars on Github, and since the last newsletter has received a PR from tomb50 to improve Orchid's Asciidoctor integration. And thank you to everyone else who has been giving Orchid a try, reaching out with questions and feedback, and generally supporting this growing community!

What's New?

Since the release of 0.18.0, I've been able to work on many smaller "quality-of-life" improvements to Orchid that have been suggested by the community. Some of these changes required breaking the internal API (thus the major version bump to 0.19.0), but the last few releases have mainly just been smaller new features and improvements to existing plugins. Below are the new features available in 0.19.0:

Improve Asciidoc formatting. Specifically, other files relative to the source file can now be included.
Automatically add CNAME files to GithubPages deploys, if not already present in the deployed site. The CNAME value will be inferred from the base URL of the site during the deploy.
Adds feedLinks metaComponent to Posts plugin, which adds <link rel='alternate'> tags to page heads, pointing to the generated feed pages.
Images uploaded and referenced from GitLab wikis are now copied over automatically with the rest of the site

Full release notes and a migration guide are available here.

In Progress

Most work over the past month has been refactoring needed to support a better Asciidoctor experience, and generally clean up some of the older parts of the Orchid codebase. This is work that will eventually be extracted to a separate library, so be on the look-out for that!

There is still work to be done with the Asciidoctor integration, but it's getting better all the time, and work on the Snippets plugin will be picking back up soon, too. I've already had some good feedback and suggestions for this feature which I will be taking into account as I build it out, so be sure to leave your thoughts on the appropriate issue, to make this plugin exactly what you need!

Are you interested in getting started with Orchid? There simply is no better way to manage all the documentation for your project, and I'd love to help you get set up!

And as always, let me know if you start using Orchid so I can feature you in the next update!

January 2020 Orchid Newsletter: Gaining Traction

Casey Brooks — Thu, 23 Jan 2020 16:08:40 +0000

It's so incredible to see this project grow from a tiny seedling to the maturing sprout it is now. Especially since the 0.18.0 release, I've seen more people try out Orchid and adopt it for their documentation sites, and I'm so incredibly grateful for each and every download. But this is only the beginning, Orchid still has lots of growing-up to do, so why don't you come along for the ride and help shape the future of Orchid!

On Github

Orchid has been growing so much since December's 0.18.0 release! Its now at 313 stars and version 0.18.2, with more downloads, new sites, and issues created than ever before! And it's all thanks to this wonderful community of individuals believing in a better way to do documentation, so thank you all!

The holidays were fairly quiet in terms of new releases and contributions, but Tom Beadman helped immensely with improving the asciidoctor integration. A small PR with huge impact for improving the quality-of-life for Asciidoctor fans, which now includes support for include::[] macros!

I also merged work Danilo Pianini had done for improving the YouTube tag to support aspect-ratios instead of fixed sized.

What's New?

Now that 0.18.0 is released, I've been able to work on some smaller features I've been wanting to support for a while. I had to restrain myself from working on them for 0.18.0 to prevent feature-creep, but it's been nice finally getting to add the following features:

The OrchidBible plugin has been broken for some time, as the APIs driving it had been decommissioned. I have removed the previously-broken bible() function, which pre-rendered Bible verses, and replaced it with a new Faithlife Reftagger meta-component, which will automatically create popups for all Bible verses it finds on the page!
Support for Mermaid JS markup has been added to the OrchidDiagrams plugin. As Mermaid is a javascript library, support is added through a meta-component instead of using pre-rendered markup like PlantUML.
The youtube template tag in OrchidWritersBlocks can now display videos of a given aspect-ratio, making them better-suited for responsive designs.
OrchidChangelog now supports single-file changelogs, such as the Keep A Changelog format format.

In Progress

Supporting include macros for Asciidoctor was a huge step forward, but there's still work to be done to improve that integration, and you can expect more Asciidoctor improvements in the coming weeks, with image::[] being the next target.

In addition to a few more quality-of-life improvements planned for the near-future, I've begun work on a new OrchidSnippets plugin! More details will come in a future post, but I'd love to get your feedback and suggestions for its implementation and usage in this issue on GitHub!

Are you interested in getting started with Orchid? There simply is no better way to manage all the documentation for your project, and I'd love to help you get set up!

And as always, let me know if you start using Orchid so I can feature you in the next update!

Make a Personal Blog with Orchid

Casey Brooks — Thu, 12 Dec 2019 16:53:26 +0000

Orchid was created to create amazing project documentation sites, but it is by no means limited to documentation. Orchid is equally good at producing blogs for your portfolio site, or even for adding a newsletter to your docs to further
engage with your users!

This tutorial will walk you through how to create a blog, complete with archives for all your posts, and get it deployed to Netlify. If you want to jump right into a working project, you can find everything described here in the OrchidTutorials example project.

orchidhq / OrchidTutorials

A collection of tutorial projects to help you learn how to use Orchid

Orchid Tutorials

This repo contains the projects used in the official Orchid tutorials. Each project top-level directory here is its own project, and can be run by navigating into that project and running the appropriate commands as described in the Orchid tutorials.

View on GitHub

Alternatively, you can simply click the "Deploy to Netlify" button below to automatically clone, build, and deploy the OrchidStarter repo to the Netlify CDN. Most of what is in this tutorial is also included in that site, so you can follow along with this tutorial using the starter repo as well.

This tutorial was originally posted on https://orchid.run. Visit the original tutorial for the most up-to-date version.

Getting Started

We'll be using Gradle for this project, and Orchid runs as a Gradle plugin. So let's get our settings.gradle and we'll also set up the build.gradle:

// settings.gradle
rootProject.name = 'My Awesome Blog'

// build.gradle
// 1. Apply Orchid plugin
plugins {
    id "com.eden.orchidPlugin" version "0.18.0"
}

// 2. Include Orchid dependencies
dependencies {
    orchidCompile "io.github.javaeden.orchid:OrchidBlog:0.18.0"
    orchidCompile "io.github.javaeden.orchid:OrchidFutureImperfect:0.18.0"
    orchidCompile "io.github.javaeden.orchid:OrchidSearch:0.18.0"
    orchidCompile "io.github.javaeden.orchid:OrchidPluginDocs:0.18.0"
}

// 3. Get dependencies from JCenter
repositories {
    jcenter()
}

// 4. Use the 'FutureImperfect' theme, and set the URL it will have on Github Pages
orchid {
    theme = "FutureImperfect"
    baseUrl = "https://project.netlify.com"
    version = "1.0.0"
}

This is all that's required to run your Orchid site! There are still a few things we need to do to set up the blog, but you can run Orchid right now with ./gradlew orchidServe and view the site on http://localhost:8080. It should give you an output like the following:

./gradlew :docs:orchidServe

> Task :docs:orchidServe
Using the following modules: 
--------------------
 * com.eden.orchid.StandardModule

Auto-loaded modules: 
--------------------
 * com.eden.orchid.editorial.EditorialModule
 * com.eden.orchid.impl.compilers.markdown.FlexmarkModule
 * com.eden.orchid.impl.compilers.pebble.PebbleModule
 * com.eden.orchid.kotlindoc.KotlindocModule
 * com.eden.orchid.pages.PagesModule
 * com.eden.orchid.search.SearchModule
 * com.eden.orchid.wiki.WikiModule

Flag values: 
-------------------------
-adminTheme: Default
-baseUrl: https://project.netlify.com
-defaultTemplateExtension: peb
-dest: ...
-dryDeploy: false
-environment: debug
-logLevel: VERBOSE
-port: 8080
-src: ...
-task: serve
-theme: Editorial
-version: 1.0.0

[INFO] Orchid: Running Orchid version 0.16.0, site version unspecified in debug environment
[INFO] OrchidWebserver: Webserver Running at http://localhost:8080
[INFO] OrchidWebsocket: Websocket running at http://localhost:8081/
[INFO] TaskServiceImpl: Build Starting...
[INFO] GeneratorServiceImpl: Indexing [10000: assets]
[INFO] GeneratorServiceImpl: Indexing [1000: home]
[INFO] GeneratorServiceImpl: Indexing [1000: kotlindoc]
[INFO] GeneratorServiceImpl: Indexing [1000: pages]
[INFO] GeneratorServiceImpl: Indexing [1000: wiki]
[INFO] GeneratorServiceImpl: Indexing [11: sitemap]
[INFO] GeneratorServiceImpl: Indexing [10: indices]
[INFO] GeneratorServiceImpl: Generating [10000: assets]
[INFO] GeneratorServiceImpl: Generating [1000: home]
[INFO] GeneratorServiceImpl: Generating [1000: kotlindoc]
[INFO] GeneratorServiceImpl: Generating [1000: pages]
[INFO] GeneratorServiceImpl: Generating [1000: wiki]
[INFO] GeneratorServiceImpl: Generating [11: sitemap]
[INFO] GeneratorServiceImpl: Generating [10: indices]

Build Metrics:
┌───────┬────────────┬───────────────┬─────────────────┬───────────────────────────┬─────────────────────────────┐
│       │ Page Count │ Indexing Time │ Generation Time │ Mean Page Generation Time │ Median Page Generation Time │
├───────┼────────────┼───────────────┼─────────────────┼───────────────────────────┼─────────────────────────────┤
│  home │     1      │     54ms      │      481ms      │           472ms           │            472ms            │
├───────┼────────────┼───────────────┼─────────────────┼───────────────────────────┼─────────────────────────────┤
│ TOTAL │          1 │      3s 496ms │           520ms │                     472ms │                       472ms │
└───────┴────────────┴───────────────┴─────────────────┴───────────────────────────┴─────────────────────────────┘

Build Complete
Generated 1 page in 4s 18ms


Webserver Running at http://localhost:8080
Hit [CTRL-C] to stop the server and quit Orchid

You will also see the basic site served on localhost:8080, which looks like:

But let's move on to the next step: adding content to the site!

Adding Content

Homepage

The first thing anyone will see when landing on your site is your Homepage. Orchid creates this page based on a homepage.md file in the root of your site's resources, which are located by default in src/orchid/resources. Let's start by creating this file and adding a short description of our project to it.

// docs/src/orchid/resources/homepage.md
# My Blog

This is a short description of this blog.

A common thing to add to your blog homepage is a list of your latest blog posts. But before we add that, we'll need to write some blog posts first.

Blog Posts

Blog posts are Markdown files in your posts/ directory, where each file is a separate blog post. The filename of the post must be in the format of YYYY-MM-DD-[post-title].md, with the publication date and the "slug" of the post which will be its path in its URL.

So let's add a few posts, such as posts/2019-01-01-post-one.md, posts/2019-02-01-post-two.md, and posts/2019-03-01-post-three.md. The contents of each file should start with a Front Matter section, where you can specify the post's title, its tags, and other metadata, and the actual post content after that. Front Matter is a block of YAML between pairs of triple-dashed lines.

# posts/2019-01-01-post-one.md
---
title: Example Post 1
featuredImage: assets/media/pic01.jpg
tags:
    - one
    - two
---

Example Post 1

You'll now have a blog post at http://localhost:8080/2019/1/1/post-one that looks like the following;

Now that we have some blog posts set up, we can go back and add the latest posts to our homepage. We can do by adding a component to the homepage's Front Matter, configured to display the latest posts. Orchid's Components are just a list of "blocks" which are rendered to the page in order. There are many different types of components, and different plugins can add their own. An example is the recentPosts component from the OrchidPosts plugin. We can also add the pageContent component, which adds the Markdown content of the homepage.md. If you don't define any components this one is added automatically, but if you use any additional components you'll have to add it yourself.

# homepage.md
---
components:
  - type: pageContent
  - type: recentPosts
    limit: 4
    noWrapper: true
    template:
      - 'includes/postPreview_large'
---
# My Blog

This is a short description of this blog.

Creating Archives

Post Archive

Now, while it is nice to show the most recent posts on your site's homepage, if you've got more than a couple posts you simply can't show a complete archive on the homepage. Instead, we can use the OrchidTaxonomies plugin to generate proper archives.

Orchid is designed around a concept of "collections" of pages. When we set up the blog posts, Orchid also created a posts collection. We can tell the Taxonomies plugin to generate an archive of any of our collections from any plugin, making it simple to create any archives we may need.

Configuring archives is done through a config.yml file in our site resources. This is the main entry-point to configuring anything in our site. The following snippet will set up a collection archive for all our blog posts.

# docs/src/orchid/resources/config.yml
taxonomies:
  collectionArchives:
    - collectionType: 'posts'
      collectionId: 'blog'

Now, if we visit http://localhost:8080/blog, we will see a listing of all our blog posts. As our blog grows, this archive will automatically become paginated, keeping any single page from growing too large.

You may wish to create archives for other collections as well. If you visit http://localhost:8080/admin while your site is serving locally, you can view Orchid's admin panel where we can see a list of all the collections that have been set up for us.

Tag Archives

But the full listing of posts may not be the only kind of archives we want! Most blogs will also contain listings of posts by tag (remember, we provided a list of tags to our posts earlier!). Orchid did not create a collection for these tagged pages, but that doesn't mean we can't create an archive for them too! The Taxonomies plugin is able to generate any kind of arbitrary archive, based on the metadata attached to each post. These are called taxonomy archives, because you get to create any kind of taxonomy (or labelling) you need.

Configuration of a taxonomy archive is similar to a collection archive, but instead of giving it the values for a collection, we tell it a property to look for in our posts' Front Matter, such as tags:

taxonomies:
  collectionArchives:
    - collectionType: 'posts'
      collectionId: 'blog'
  taxonomies:
    - key: tags
      single: false
      orderBy:
        - entryCount

This will now go through all our posts, find any that have a tags property in its Front Matter, and add it to that archive. And this will actually create two archives for each "taxonomy": one listing all the pages with each tag (a term archive), and another archive simply listing all the tags that it found (a taxonomy archive).

http://localhost:8080/tags

http://localhost:8080/tags/one

Site Info/Theme Configuration

With the skeleton of our site content set up, it's time to make some customizations to the theme and add additional info about your site, such as its name and the author of your posts. These can be added to config.yml, just like how we configured the archives.

# docs/src/orchid/resources/config.yml
site:
  about:
    siteName: My Blog
    siteDescription: This is a short description of this blog.
    avatar: 'http://lorempixel.com/320/320/city/'
theme:
  social:
    github: 'username/project'

But these configuration values didn't just come out of nowhere. Going back to the admin panel, you can find all the options available for customization for your theme, for components, and for just about anything else.

There's a final bit of info that we should need to config.yml before finishing: setting the author for all our posts.

You would normally add the necessary configuration to each post's Front Matter, but it is really difficult, time-consuming, and error-prone to copy this data to each post file. Instead, Orchid has Archetypes which allow you to set that configuration once in config.yml and have it shared amongst a bunch of pages just as if it were added to the Front Matter of each one.

For adding configuration values to all post pages, use posts.postPages in the config.yml. We'll add an author to the blog by adding an item to the posts.authors list, and using the archetype we'll set the author for each page to the one you just set up:

# docs/src/orchid/resources/config.yml
posts:
  authors:
    - name: 'Author One'
      avatar: 'http://lorempixel.com/320/320/animals/'
      email: 'email@domain.tld'
  postPages:
    author: 'Author One'

Deploy On Netlify

Our site is now ready to be deployed! For blogs and personal sites, you really can't go wrong with Netlify as your site host. It offers everything you could want for both small and large sites, such as purchasing custom domains, form handling, and automated site deploys. While Orchid has its own Netlify publisher for advanced use cases, it's far simpler to use Netlify as intended.

All you need to do is create an account at https://www.netlify.com/, add a netlify.toml file to the root of your repo with the following content, and push to GitHub.

[build]
  base    = ""
  publish = "build/docs/orchid"
  command = "./gradlew orchidBuild -Penv=prod"

Now, once you've connected that repo to Netlify, they will take care of the rest! Of course, this is just the minimum needed to deploy, and I'd encourage you to also check out their full documentation for more help building and deploying your Orchid site on Netlify.

Conclusion

And with all that, our blog site is finished! Now it may have seemed like a ton of work getting all that setup, but let's recall all the features included in this site:

A homepage that displays our latest blog posts
A full, paginated archive of all blog posts
A listing of all tags in your blog
An archive for all the pages with each tag
Ability to set the author for each post
Ability to easily change the configurations for all your blog posts from a single location, instead of copying data to each post

And everything outlined in this tutorial is really just a sampling of the full functionality available in Orchid! Orchid has other plugins for different source code documentation, presentations, wikis, and much more. Check out the full list of plugins here, or you can even make your own!

Thanks for following along, happy blogging!

Orchid 0.18.0, The New Face of Orchid

Casey Brooks — Tue, 10 Dec 2019 16:12:46 +0000

It's. Finally. Here. I've been working on and teasing a new major version of Orchid for several months, and it's finally available! This release represents a major step in the maturity of Orchid, coming alongside the move to a new GitHub organization, a completely redesigned website, and a brand new logo!

orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you

Build and deploy beautiful documentation sites that grow with you

Quick-Start • Documentation • Tutorials • Showcase • Support

Quick-Start

Documentation

Orchid's User Manual will walk you through the main features of Orchid and give you a deeper understanding of each topic and feature.

Documentation

Tutorials

There are several tutorials designed to walk you through building an Orchid site from scratch. The source for all tutorials can also be found in the OrchidTutorials repository.

Tutorials

Showcase

View the Showcase to see Orchid in action.

Showcase

Support

Contributors

This project exists thanks to all the people who contribute. To get involved, please see CONTRIBUTING.md

Backers

Thank you to all our backers! 🙏

License

Orchid is open-source software licensed under the GNU Lesser General Public License (LGPL-3.0). Please see License.md

Contact

…

View on GitHub

On Github

As of the time of writing, Orchid is at 278 stars on Github, thank you so much for all the support!

Since the last update, Orchid has had several contributions, especially during Hacktoberfest, so a special thanks goes out to the following individuals for their help improving this project:

spind42 - Fixed an issue running Orchid from Maven
Jean-Michel Fayard - Added a readme badge for CodeTriage
Steve S - Added a new Spotify tag to the OrchidWritersBlocks plugin
Steve Waldman - Wrote a plugin to run Orchid from SBT!

What's New?

The long-awaited version 0.18.0 has finally arrived!

This release includes a major cleanup to Orchid's internal APIs, which will help make better plugins moving forward, but most importantly introduces the new, completely rewritten code documentation system based on Kodiak. The new system improves consistency of generated docs among all languages and enables multi-module documentation. It also paves the way to make it significantly easier to develop integrations for other languages, so let me know which languages you would like to see supported by Orchid!

Be sure to check out the Changelog for the full list of changes, and the Migration Guide for help updating to this new version.

In addition, some of you may have noticed a few changes around the Orchid ecosystem! The Orchid repo has been moved to @orchidhq on Github, and we have a completely redesigned documentation site and new logos. Together with the 0.18.0 release, this marks the biggest change in the development and ecosystem of Orchid to help cement it is as the single-best tool for producing documentation websites.

You can help spread the word about this major milestone by sharing https://orchid.run and tagging @OrchidSSG on Twitter!

Who's Using Orchid?

I periodically search GitHub to find new projects getting set up with Orchid. Here are a couple great examples of projects being documented with Orchid:

For more examples of sites using Orchid, head on over to our new Showcase, and feel free to reach out or submit a PR to add your site to the showcase as well!

Are you interested in getting started with Orchid? There simply is no better way to manage all the documentation for your project, and I'd love to help you get set up!

And as always, let me know if you start using Orchid so I can feature you in the next update!

DEV Community: Orchid

0.21.0 Released

On Github

What's New?

In Progress

New Snippets plugin, 0.20.0 Released

On Github

What's New?

In Progress

0.19.0 Released

On Github

What's New?

In Progress

January 2020 Orchid Newsletter: Gaining Traction

On Github

What's New?

In Progress

Make a Personal Blog with Orchid

orchidhq / OrchidTutorials

A collection of tutorial projects to help you learn how to use Orchid

Orchid Tutorials

Getting Started

Adding Content

Homepage

Blog Posts

Creating Archives

Post Archive

Tag Archives

Site Info/Theme Configuration

Deploy On Netlify

Conclusion

Orchid 0.18.0, The New Face of Orchid

orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you

Quick-Start

Documentation

Tutorials

Showcase

Support

Contributors

Backers

Sponsors

License

Contact

On Github

What's New?

Who's Using Orchid?