Skip to content

Commit

Permalink
Mention the deploy script
Browse files Browse the repository at this point in the history
  • Loading branch information
bbatsov committed Jan 9, 2019
1 parent 79319d0 commit 82de874
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.adoc
Expand Up @@ -18,6 +18,15 @@ $ ./antora site.yml

TIP: If `npm install` fails, see link:https://docs.antora.org/antora/1.1/install/troubleshoot-nodegit/[Antora's troubleshooting documentation].

After you're done with the initial setup you can use the `deploy` script to push changes to the site:

[source]
----
./deploy
----

NOTE: You'll need commit access to the repository for this to work.

To check the generated site you can simply open `docs/index.html` in your favourite browser.

If you want to make changes to the manual's page structure you'll have to edit
Expand Down
2 changes: 1 addition & 1 deletion deploy
Expand Up @@ -2,5 +2,5 @@

./antora --pull site.yml
git add docs
git commit -m 'Bump site docs'
git commit -m 'Update site docs'
git push

0 comments on commit 82de874

Please sign in to comment.