Skip to content

Commit f41f0b6

Browse files
author
Igal Levy
committed
updates readme with more info
1 parent 9d47dfb commit f41f0b6

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
This is a test of what can be used to generate the MDAI project documentation.
44

5-
This uses the GitHub Way of generating documentation, with local testing.
5+
This uses the GitHub Way of generating documentation, with local testing if you install [Jekyll](https://jekyllrb.com/) locally.
66

7-
Local testing means installing Jekyll (and all of the Ruby stuff)
8-
to build the site locally for a sanity check. Then push to the repo
7+
Local testing means installing [Jekyll](https://jekyllrb.com/) locally.
8+
Build the site locally for a sanity check. Then push to the repo
99
to have GitHub actions build the site on the remote.
1010

1111
*Note:* The GitHub actions can take a few minutes to build the site.
1212

13-
Jekyll supports the Liquid templating language.
13+
Jekyll supports the [Liquid templating language](https://jekyllrb.com/docs/step-by-step/02-liquid/).
1414

15-
We're also trying out the Just the Docs theme instead of the built-in
15+
We're also trying out the [Just the Docs theme](https://just-the-docs.com/) instead of the built-in
1616
Jekyll theme or any of the other "approved" Jekyll. Just the Docs is
1717
designed for documentation, is well-supported, and designed to work
1818
in Jekyll with GitHub pages.
19+
20+
[Help for setting up in GitHub](https://docs.github.com/en/pages) should be pretty straight forward.

0 commit comments

Comments
 (0)