Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add docs for tera features for the template documenation #2584

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

erickguan
Copy link
Contributor

@erickguan erickguan commented Sep 15, 2024

Closes #2048

Please raises comments for the document structure and general documentation improvements.

This should be merged after closing #2049.

@jdx
Copy link
Owner

jdx commented Sep 18, 2024

you've got a lot of lint errors and a merge conflict

@erickguan erickguan force-pushed the template-doc branch 3 times, most recently from 9baab15 to 328ce80 Compare September 18, 2024 20:34
@erickguan
Copy link
Contributor Author

Fixed!

// languages: [
// "elisp"
// ]
config(md) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is this for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vitepress seems doing some magic on inline code block. e.g., vitepress doesn't render {{. [vitepress](https://github.com/vuejs/vitepress/discussions/480) recommends to either use <code v-pre>{{ 1 + 1 }}</code> or this config.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with HTML blocks.

- `if version is semver_matching(String)` – Confirms if a version string matches
a semantic version pattern (e.g., `if "1.10.2" is semver_matching("^1.10.0")`).

### Example Templates
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all of these examples look wrong in several places, have you actually tested them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ugh, my ChatGPT practice is not going so hot. I configured a few templates and build some examples. The examples should work now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

template documentation improvements
2 participants