You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The manual is generated from the markdown files in the
37
-
https://github.com/bbatsov/projectile/tree/master/doc[doc] folder of Projectile's
38
-
GitHub repo and is published to link:readthedocs.org[Read the Docs]. The
39
-
http://www.mkdocs.org/[MkDocs] tool is used to convert the markdown sources to
40
-
HTML.
36
+
The manual is generated from the AsciiDoc files in the link:https://github.com/bbatsov/projectile/tree/master/doc[doc] folder of Projectile's GitHub repo and is published to https://docs.projectile.mx.
37
+
link:https://antora.org[Antora] is used to convert the manual into HTML.
38
+
The filesystem layout is described at https://docs.antora.org/antora/2.0/component-structure/.
41
39
42
-
To make changes to the manual you simply have to change the files under
43
-
`doc`. The manual will be regenerated automatically when changes to those files
44
-
are merged in `master` (or the latest stable branch).
40
+
To make changes to the manual you simply have to change the files under `doc`.
41
+
The manual will be regenerated manually periodically.
45
42
46
-
You can install `MkDocs` locally and use the command `mkdocs serve` to see the
47
-
result of changes you make to the manual locally:
43
+
==== Installing Antora
48
44
49
-
[source,sh]
45
+
NOTE: The instructions here assume you already have (the right version of) node.js installed.
46
+
47
+
Installing the Antora is super simple:
48
+
49
+
[source]
50
+
----
51
+
$ npm i -g @antora/cli@2.0 @antora/site-generator-default@2.0
50
52
----
51
-
$ cd path/to/projectile/repo
52
-
$ mkdocs serve
53
+
54
+
Check out https://docs.antora.org/antora/2.0/install/install-antora/[the detailed installation instructions]
55
+
if you run into any problems.
56
+
57
+
==== Building the Site
58
+
59
+
You can build the documentation locally from the link:https://github.com/bbatsov/docs.projectile.mx[docs.projectile.mx] repo.
60
+
61
+
[source]
53
62
----
63
+
$ cd docs.projectile.mx
64
+
$ antora --pull antora-playbook.yml
65
+
----
66
+
67
+
After you're done with the initial setup you can use the `deploy` script to push changes to the site:
68
+
69
+
[source]
70
+
----
71
+
./deploy
72
+
----
73
+
74
+
NOTE: You'll need commit access to the repository for this to work.
75
+
76
+
To check the generated site you can simply open `docs/index.html` in your favourite browser.
54
77
55
78
If you want to make changes to the manual's page structure you'll have to edit
0 commit comments