Clarify which files are ignored or copied. #1013
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
tlienart
approved these changes
Apr 23, 2023
docs/syntax/page-variables.md
Outdated
| \smindent{(\*\*\*)} \smnote{to ignore a file add it's relative path like `"path/to/file.md"`, to ignore a directory end the path with a `/` like `"path/to/dir/"`.}. | ||
| \smindent{(\*)} \smnote{Say you're using GitHub pages and your username is `darth`, by default Franklin will assume the root URL to be `darth.github.io/`. However, if you want to build a project page so that the base URL is `darth.github.io/vador/` then use `@def prepath = "vador"`}\\ | ||
| \smindent{(\*\*)} \smnote{Must be in a format recognized by Julia's `Dates.DateLocale`. Defaults to English. If left unset, the short names are created automatically by using the first three characters of the full names.}\\ | ||
| \smindent{(\*\*\*)} \smnote{To ignore a file add it's relative path like `"path/to/file.md"`, to ignore a directory end the path with a `/` like `"path/to/dir/"`. Always ignored are `.DS_Store`, `.gitignore`, `LICENSE.md`, `README.md`, `franklin`, `franklin.pub`, and `node_modules/` (see [`IGNORE_FILES`](https://github.com/tlienart/Franklin.jl/blob/master/src/utils/paths.jl#L14)).} |
There was a problem hiding this comment.
That might not be ideal because a change to that file would make that link obsolete. We could use a permalink here I guess.
|
Just a minor thing re link. Thank you for your contributions! |
|
Ok, I changed the link to a permalink. This might also become obsolete but I feel it is better to have an old link that still points "in the right direction" than no link. |
|
Thank you! |
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.
No description provided.