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
`term`. If you wish to hide a heading from any index prefix it with the empty
122
+
`term`. If you wish to hide a heading from any index, prefix it with the empty
124
123
comment `Z<>`.
125
124
126
125
When providing a code example result or output, use this style:
@@ -154,8 +153,8 @@ See [Writing and Testing Examples](writing-docs/EXAMPLES.md)
154
153
155
154
## Testing method completeness
156
155
157
-
To get a list of methods that are found via introspection but not
158
-
found in any Pod 6 file under `doc/Type/`, use `util/list-missing-methods.p6`. It takes a
156
+
To get a list of methods that are found via introspection but not found in any
157
+
Pod 6 file under `doc/Type/`, use `util/list-missing-methods.p6`. It takes a
159
158
directory or filepath as argument and limits the listing to the given file or
160
159
any Pod 6-files found. All methods listed in `util/ignored-methods.txt` are
161
160
ignored.
@@ -167,7 +166,7 @@ the page to activate debug mode. The state of debug mode will be remembered by
167
166
`window.sessionStorage` and will not survive a browser restart or opening the
168
167
docs in a new tab.
169
168
170
-
q### Invisible index anchors
169
+
### Invisible index anchors
171
170
172
171
You can create index entries and invisible anchors with `X<|thing,category>`.
173
172
To make them visible activate debug mode.
@@ -207,7 +206,7 @@ If you would like to contribute documentation or other bug fixes, please use
207
206
Assuming that you have already forked and cloned the
208
207
[perl6/doc](https://github.com/perl6/doc) repository, one of the first things
209
208
you probably want to do is to build the documentation on your local
210
-
computer. To do this you will need:
209
+
computer. To do this you will need:
211
210
212
211
- Perl 6 (e.g., the Rakudo Perl 6 implementation)
213
212
- zef (the installer for third party Perl 6 modules)
@@ -290,7 +289,7 @@ To actually build the documentation all you now need to do is run:
290
289
This takes a while, but be patient!
291
290
292
291
After the build has completed, you can start the web application which will
293
-
render the HTML documention on a web server on your build host:
292
+
render the HTML documentation on a web server on your build host:
294
293
295
294
$ make run
296
295
@@ -299,12 +298,14 @@ documentation.
299
298
300
299
#### Using Docker to build and view the documentation
301
300
302
-
You can skip all the above and just build and view documentation with these simple commands (if you have docker already installed):
301
+
You can skip all the above and just build and view documentation with these
302
+
simple commands (if you have docker already installed):
303
303
304
304
$ docker build -t perl6-doc .
305
305
$ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc
306
306
307
-
This will build the documentation for you by default and it will take some time, but for subsequent use you may want to skip build part if nothing has been changed:
307
+
This will build the documentation for you by default and it will take some time,
308
+
but for subsequent use you may want to skip build part if nothing has been changed:
308
309
309
310
$ docker run -p 3000:3000 -it -v `pwd`:/perl6/doc perl6-doc ./app-start
310
311
@@ -322,14 +323,14 @@ To run the development web server for viewing documentation (on port 3000):
322
323
323
324
$ make docker-run
324
325
325
-
Note that while this requires less typing, some assumptions will be made for you regarding the name
326
-
of the resulting image, the port the content is available over, etc. If you want, you can
327
-
override these default values.
326
+
Note that while this requires less typing, some assumptions will be made for
327
+
you regarding the name of the resulting image, the port the content is available
328
+
over, etc. If you want, you can override these default values.
328
329
329
-
For instance, if you want the local documentation to be available over port 5001 of the host,
330
-
pass the following to make when running:
330
+
For instance, if you want the local documentation to be available over port 5001
331
+
of the host, pass the following to make when running:
331
332
332
333
$ make docker-run DOCKER_HOST_PORT=5001
333
334
334
-
Now the documentation will be available on the host at http://localhost:5001. Please see the
335
-
Makefile for a list of available options.
335
+
Now the documentation will be available on the host at http://localhost:5001.
336
+
Please see the Makefile for a list of available options.
0 commit comments