Doc 17 add usage documentation #30
Merged
Conversation
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
lebouquetin
requested changes
Jul 8, 2024
| @@ -1,16 +1,13 @@ | |||
| # JSSG - Jtremesay's Static Site Generator | |||
| # JFM-Engine | |||
There was a problem hiding this comment.
Add an explanation, something like this: jsm-engine is a friendly fork of jssg made in agreement with the JSSG developer because of different goals. See jtremesay/jssg#21
Note: this explanation may be put at the end of the README. This is not the first information the user wants to read (but it's fair to put it on the project readme)
README.md
Outdated
|
|
||
| Otherwise, you have to configure the following settings : | ||
| - `JSSG_DOMAIN` : the domain name of your website, for instance `"https://www.example.com"` (used in sitemap file) | ||
| - `JSSG_CONTENT_DIR` : a list of directories where to look for the site content |
There was a problem hiding this comment.
note: if the var contains a list, then the naming should be explicit: JSSG_CONTENT_DIR -> JSSG_CONTENT_DIRS.
By the way, I suggest to rename it to JFME_CONTENT_DIRS (and JFME_DOMAIN)
Rename settings
lebouquetin
approved these changes
Jul 8, 2024
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#17