File tree Expand file tree Collapse file tree 1 file changed +7
-5
lines changed Expand file tree Collapse file tree 1 file changed +7
-5
lines changed Original file line number Diff line number Diff line change 2
2
3
3
This is a test of what can be used to generate the MDAI project documentation.
4
4
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 .
6
6
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
9
9
to have GitHub actions build the site on the remote.
10
10
11
11
* Note:* The GitHub actions can take a few minutes to build the site.
12
12
13
- Jekyll supports the Liquid templating language.
13
+ Jekyll supports the [ Liquid templating language] ( https://jekyllrb.com/docs/step-by-step/02-liquid/ ) .
14
14
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
16
16
Jekyll theme or any of the other "approved" Jekyll. Just the Docs is
17
17
designed for documentation, is well-supported, and designed to work
18
18
in Jekyll with GitHub pages.
19
+
20
+ [ Help for setting up in GitHub] ( https://docs.github.com/en/pages ) should be pretty straight forward.
You can’t perform that action at this time.
0 commit comments