Skip to content

Commit

Permalink
updates readme with more info
Browse files Browse the repository at this point in the history
  • Loading branch information
Igal Levy committed Nov 11, 2024
1 parent 9d47dfb commit f41f0b6
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,19 @@

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.
This uses the GitHub Way of generating documentation, with local testing if you install [Jekyll](https://jekyllrb.com/) locally.

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
Local testing means installing [Jekyll](https://jekyllrb.com/) locally.
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.
Jekyll supports the [Liquid templating language](https://jekyllrb.com/docs/step-by-step/02-liquid/).

We're also trying out the Just the Docs theme instead of the built-in
We're also trying out the [Just the Docs theme](https://just-the-docs.com/) 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.

[Help for setting up in GitHub](https://docs.github.com/en/pages) should be pretty straight forward.

0 comments on commit f41f0b6

Please sign in to comment.