Skip to content

Commit 9b97e42

Browse files
author
Igal Levy
committed
adds readme file
1 parent f4541c9 commit 9b97e42

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Welcom to the Test of MDAI Documentation Via Jekyll and GitPages!
2+
3+
This is a test of what can be used to generate the MDAI project documentation.
4+
5+
This uses the GitHub Way of generating documentation, with local testing.
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
9+
to have GitHub actions build the site on the remote.
10+
11+
*Note:* The GitHub actions can take a few minutes to build the site.
12+
13+
Jekyll supports the Liquid templating language.
14+
15+
We're also trying out the Just the Docs theme instead of the built-in
16+
Jekyll theme or any of the other "approved" Jekyll. Just the Docs is
17+
designed for documentation, is well-supported, and designed to work
18+
in Jekyll with GitHub pages.

0 commit comments

Comments
 (0)