Skip to content

About

Stores the markdown documents used to generate docs.openrewrite.org

Resources

Contributing

Stars

55 stars

Watchers

4 watching

Forks

Repository files navigation

Rewrite Docs

The docs behind docs.openrewrite.org.

Recipe docs

Recipe docs now live in the Code Genome Project, and the old recipe URLs here redirect to them. If you wish to change a recipe's name, description, tags, or examples, please update the recipe itself.

Generated pages

The changelog and the latest versions, copied from moderne-docs, are updated nightly by the Update docs workflow. To update them locally, set codegenomeUsername and codegenomePassword in ~/.gradle/gradle.properties, sign in with gh or set GITHUB_TOKEN, then run:

./gradlew updateDocs

Contributing

We encourage you to contribute to our docs! Please feel free to create an issue or open a PR if you find any issues. See the contributing guide for writing standards and how to describe your pull request.

Local preview

This project uses Docusaurus to manage the documentation. To preview the docs locally, you can run the following command:

npx docusaurus start;

About

Stores the markdown documents used to generate docs.openrewrite.org

Resources

Contributing

Stars

55 stars

Watchers

4 watching

Forks

Contributors

Languages