The import button lets users create their own copy of your project and import it into Forestry in one fell swoop.
If you have a static site project — like a theme or starter site — that is optimized for use with Forestry and you want to share it, adding an import button to your README or website will make it easy for users to get started using your project with Forestry.
The Add Site URL
Your import button will use our quick start flow to clone the project into the user’s account and import it into Forestry. The most basic add site URL will look like this:
https://app.forestry.io/quick-start?repo=user/project. In this case, the
repo parameter is the path to the repo on Github. Quick start accepts the following URL parameters:
||Path to repository, of the format
||Which git provider your repository is hosted from||
||The static site generator used by your project.||
||The Hugo version to use (only applies when engine is
||The repository branch to import||String||
||Relative path to your source files||String||
Your project should be a fully functional static site project that can be imported into Forestry, and should be available from a public repository on Github, GitLab, or BitBucket.
For example, if you want to create an import button for your Hugo theme, you should create a new Hugo site configured to use your theme. Forestry won’t be able to import your theme code on its own, as it doesn’t share the same file structure as a Hugo site.
We have provided three SVG buttons for your use:
You can use our button generator below to create the appropriate markup for your button.
Caught a mistake or want to contribute to the docs? Edit this page on Github!