Get the Site Playbook Project
The Docs Site playbook project contains the:
-
staging playbook
-
production playbook
-
site extensions
-
Home docs component
To generate the documentation site on your device, you need its playbook. The playbook provides the site configuration to Antora.
Fork and Clone the Playbook Project
| Go to Build the Docs Site if you’ve previously forked and cloned the Docs Site repository. You’ve already completed the steps on this page. |
-
Go to the Docs Site repository on GitHub and click Fork.
-
Create or select the local folder where you want to store the repository on your device.
-
Open a terminal and change into the selected folder.
$ cd path/to/folder
-
Go to your repository on GitHub, and click Clone or download.
-
Click the Clipboard icon to copy the repository’s Git URL.
-
In your terminal type
git clone, paste the copied URL, and press Enter.$ git clone git@github.com:this-is-you/docs-site.git
-
Change into the repository folder created by the clone operation.
$ cd docs-site
Sync with the Upstream Repository
You need to connect your local repository to the upstream repository so you can use the latest playbooks and extensions.
-
Go to the upstream Docs Site repository and click Clone or download.
-
Click the Clipboard icon to copy the repository’s Git URL.
-
In your terminal type
git remote add upstream, paste the copied URL, and press Enter.
Now you’re ready to run Antora and build the documentation site on your device.