-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Igal Levy
committed
Nov 1, 2024
1 parent
f4541c9
commit 9b97e42
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Welcom to the Test of MDAI Documentation Via Jekyll and GitPages! | ||
|
||
This is a test of what can be used to generate the MDAI project documentation. | ||
|
||
This uses the GitHub Way of generating documentation, with local testing. | ||
|
||
Local testing means installing Jekyll (and all of the Ruby stuff) | ||
to build the site locally for a sanity check. Then push to the repo | ||
to have GitHub actions build the site on the remote. | ||
|
||
*Note:* The GitHub actions can take a few minutes to build the site. | ||
|
||
Jekyll supports the Liquid templating language. | ||
|
||
We're also trying out the Just the Docs theme instead of the built-in | ||
Jekyll theme or any of the other "approved" Jekyll. Just the Docs is | ||
designed for documentation, is well-supported, and designed to work | ||
in Jekyll with GitHub pages. |