https://github.com/orchidhq/Orchid

Build and deploy beautiful documentation sites that grow with you
https://github.com/orchidhq/Orchid

blog documentation dokka javadoc kotlin static-site-generator wiki

Last synced: 5 days ago
JSON representation

Build and deploy beautiful documentation sites that grow with you

• Host: GitHub
• URL: https://github.com/orchidhq/Orchid
• Owner: orchidhq
• License: gpl-3.0
• Created: 2016-12-16T16:03:23.000Z (almost 8 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-30T03:07:07.000Z (10 days ago)
• Last Synced: 2024-10-30T06:13:50.592Z (10 days ago)
• Topics: blog, documentation, dokka, javadoc, kotlin, static-site-generator, wiki
• Language: Kotlin
• Homepage: https://orchid.run
• Size: 28.8 MB
• Stars: 517
• Watchers: 17
• Forks: 53
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: License.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-starred - orchidhq/Orchid - Build and deploy beautiful documentation sites that grow with you (kotlin)

README

        


  

    

  

  


  Build and deploy beautiful documentation sites that grow with you







  

    

  

  

    

  

  

    

  

  

    

  

  





  Quick-Start

  •

  Documentation

  •

  Tutorials

  •

  Showcase

  •

  Support



## Quick-Start



  






  



  






  



  








  






Orchid 0.X.X versions are published to [JCenter](https://jcenter.bintray.com/) at artifact coordinates like `io.github.javaeden.orchid:OrchidCore:0.21.1` or `io.github.javaeden.orchid:OrchidWiki:0.21.1`. JCenter is deprecated, and once Orchid 1.0.0 is published, so will all 0.X.X versions.

Starting with version 1.0.0, Orchid will be published to [MavenCentral](https://repo1.maven.org/maven2/) under new artifact coordinates, like `io.github.copper-leaf.orchid:orchid-core:1.0.0` or `io.github.copper-leaf.orchid:orchid-wiki-feature:1.0.0`.

In-development snapshot versions will be available in [Sonatype's new (s01) snapshots repository](https://s01.oss.sonatype.org/content/repositories/snapshots/). Snapshots are published after every successful build on the `dev` branch.

## 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](https://orchid.run/wiki/user-manual/getting-started)

## 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](https://github.com/orchidhq/OrchidTutorials).

[Tutorials](https://orchid.run/wiki/learn)

## Showcase

View the Showcase to see Orchid in action.

[Showcase](https://orchid.run/showcase)

## Support

### Contributors

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

[CONTRIBUTING.md](https://github.com/orchidhq/orchid/blob/dev/.github/CONTRIBUTING.md)



  



### Backers

Thank you to all our backers! 🙏



  



### Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.



  





  





  





  





  





  





  





  





  





  



### License

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

[License.md](https://github.com/orchidhq/orchid/blob/dev/License.md)

### Contact

Orchid is being actively developed by Casey Brooks. You can reach out with questions, bug reports, or feature requests 

on any of the following:

- [Github Issues](https://github.com/orchidhq/Orchid/issues) 

- [Twitter](https://twitter.com/OrchidSSG)

- [Email me directly](mailto:[email protected])