Skip to content

Commit bf4e4bb

Browse files
vemvbbatsov
authored andcommitted
Introduce a Makefile
1 parent f8ed3a9 commit bf4e4bb

File tree

5 files changed

+29
-11
lines changed

5 files changed

+29
-11
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/package-lock.json

Makefile

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.PHONY: npm build deploy
2+
.DEFAULT_GOAL := build
3+
4+
npm: package.json
5+
npm install --no-fund --no-audit --no-progress --save-dev --loglevel=error
6+
npm run antora -- --version
7+
8+
build: npm
9+
npm run antora -- --fetch antora-playbook.yml
10+
11+
deploy: build
12+
git add docs
13+
git commit -m 'Update site docs'
14+
git push

README.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Installing the Antora is super simple:
1313

1414
[source]
1515
----
16-
$ npm i -g @antora/[email protected] @antora/[email protected]
16+
$ make npm
1717
----
1818

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

2626
[source]
2727
----
28-
$ cd cider-site
29-
$ antora --pull antora-playbook.yml
28+
$ cd docs.cider.mx
29+
$ make build
3030
----
3131

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

3434
[source]
3535
----
36-
./deploy
36+
$ make deploy
3737
----
3838

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

deploy

-6
This file was deleted.

package.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"dependencies": {
3+
"@antora/cli": "3.1.3",
4+
"@antora/site-generator": "3.1.3"
5+
},
6+
"scripts": {
7+
"antora": "antora"
8+
}
9+
}

0 commit comments

Comments
 (0)