docs: add GitHub buttons and improve option docs

This commit is contained in:
Yang Jun
2026-06-06 13:28:29 +08:00
parent a8fd734b5e
commit a75033e2ca
5 changed files with 8 additions and 5 deletions
+1
View File
@@ -3,6 +3,7 @@
<h2 id="banner-title">{{ page.subtitle }}</h2>
<div id="banner-start">
<code id="banner-start-command">npm install liquidjs</code><a id="banner-start-link" href="./tutorials/setup.html"><i class="icon-arrow-right"></i></a>
<a id="banner-github-link" href="https://github.com/{{ config.github }}" target="_blank" rel="noreferrer">GitHub</a>
</div>
<div id="banner-share">{{ partial('partial/share') }}</div>
</div>
+1
View File
@@ -5,6 +5,7 @@
{{ js('js/main') }}
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script>
document.getElementById('search-input-wrap').classList.add('on');
+4 -1
View File
@@ -18,7 +18,10 @@
{% endfor %}
</select>
</div>
<a href="https://github.com/{{ config.github }}" class="main-nav-link icon-nav-link"><i class="icon-github"></i> <span class="icon-nav-title">GitHub</span></a>
<div class="main-nav-link icon-nav-link github-buttons-wrap">
<a class="github-button" href="https://github.com/harttle/liquidjs" data-color-scheme="no-preference: light; light: light; dark: dark;" data-size="large" data-show-count="true" aria-label="Star harttle/liquidjs on GitHub">Star</a>
<a class="github-button" href="https://github.com/sponsors/harttle" data-color-scheme="no-preference: light; light: light; dark: dark;" data-size="large" aria-label="Sponsor @harttle on GitHub">Sponsor</a>
</div>
<a id="mobile-nav-toggle">
<span class="mobile-nav-toggle-bar"></span>
<span class="mobile-nav-toggle-bar"></span>
+1 -1
View File
@@ -72,7 +72,7 @@ export interface LiquidOptions {
fs?: FS;
/** keyValue separator */
keyValueSeparator?: string;
/** Render from in-memory `templates` mapping instead of file system. File system related options like `fs`, 'root', and `relativeReference` will be ignored when `templates` is specified. */
/** Render from an in-memory `templates` mapping instead of the file system. When `templates` is set, Liquid uses the provided mapping for template lookup (including includes, layouts, and partials), and file-system options such as `fs`, `root`, `partials`, `layouts`, and `relativeReference` are effectively bypassed for those lookups. */
templates?: {[key: string]: string};
/** the global scope passed down to all partial and layout templates, i.e. templates included by `include`, `layout` and `render` tags. */
globals?: object;
+1 -3
View File
@@ -9,9 +9,7 @@
"skipLibCheck": true,
"allowSyntheticDefaultImports": true,
"resolveJsonModule": true,
"downlevelIteration": true,
"strict": true,
"suppressImplicitAnyIndexErrors": true
"strict": true
},
"all": true,
"exclude": [ "node_modules", "dist", "demo", "test" ]