Skip to content

Commit fc8d1d9

Browse files
committed
Tweak the README
1 parent 39b1cb0 commit fc8d1d9

File tree

1 file changed

+5
-15
lines changed

1 file changed

+5
-15
lines changed

README.adoc

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
== nREPL.org
1+
= nREPL.org
22

33
The site is generated from the AsciiDoc files in the link:https://github.com/nrepl/nrepl/tree/master/doc[doc] folder of nREPL's GitHub repo and is published to https://nrepl.org.
44
link:https://antora.org[Antora] is used to convert the manual into HTML.
@@ -7,33 +7,23 @@ The filesystem layout is described at https://docs.antora.org/antora/2.0/compone
77
To make changes to the manual you simply have to change the files under `doc`.
88
The manual will be regenerated manually periodically.
99

10-
== Installing Antora
11-
12-
Installing the Antora is super simple:
13-
14-
[source]
15-
----
16-
$ npm i -g @antora/[email protected] @antora/[email protected]
17-
----
18-
19-
Check out https://docs.antora.org/antora/2.3/install/install-antora/[the detailed installation instructions]
20-
if you run into any problems.
21-
2210
== Building the Site
2311

12+
NOTE: You'll need to install `node.js` to build the site.
13+
2414
You can build the documentation locally from this repo.
2515

2616
[source]
2717
----
2818
$ cd nrepl.org
29-
$ antora --pull antora-playbook.yml
19+
$ make build
3020
----
3121

3222
After you're done with the initial setup you can use `make` to push changes to the site:
3323

3424
[source]
3525
----
36-
make deploy
26+
$ make deploy
3727
----
3828

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

0 commit comments

Comments
 (0)