Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce a Makefile #3

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/package-lock.json
14 changes: 14 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.PHONY: npm build deploy
.DEFAULT_GOAL := build

npm: package.json
npm install --no-fund --no-audit --no-progress --save-dev --loglevel=error
npm run antora -- --version

build: npm
npm run antora -- --fetch antora-playbook.yml

deploy: build
git add docs
git commit -m 'Update site docs'
git push
10 changes: 5 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Installing the Antora is super simple:

[source]
----
$ npm i -g @antora/[email protected] @antora/[email protected]
$ make npm
----

Check out https://docs.antora.org/antora/2.0/install/install-antora/[the detailed installation instructions]
Expand All @@ -25,15 +25,15 @@ You can build the documentation locally from this repo.

[source]
----
$ cd cider-site
$ antora --pull antora-playbook.yml
$ cd docs.cider.mx
$ make build
----

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

[source]
----
./deploy
$ make deploy
----

NOTE: You'll need commit access to the repository for this to work.
Expand Down
6 changes: 0 additions & 6 deletions deploy

This file was deleted.

9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"dependencies": {
"@antora/cli": "3.1.3",
"@antora/site-generator": "3.1.3"
},
"scripts": {
"antora": "antora"
}
}