https://github.com/hugo-fixit/shortcode-docs-bookmark
🔖 Embed bookmark of FixIt Docs.
https://github.com/hugo-fixit/shortcode-docs-bookmark
fixit-docs-bookmark hugo hugo-fixit shortcodes theme-component
Last synced: 3 months ago
JSON representation
🔖 Embed bookmark of FixIt Docs.
- Host: GitHub
- URL: https://github.com/hugo-fixit/shortcode-docs-bookmark
- Owner: hugo-fixit
- License: mit
- Created: 2024-07-14T07:39:56.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-01T12:43:36.000Z (10 months ago)
- Last Synced: 2025-03-27T13:51:20.929Z (4 months ago)
- Topics: fixit-docs-bookmark, hugo, hugo-fixit, shortcodes, theme-component
- Language: SCSS
- Homepage: https://lruihao.cn/posts/fixit-docs-bookmark/
- Size: 11.7 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fixit-docs-bookmark
🔖 Embed bookmark of FixIt Docs.

## Requirements
- FixIt v0.3.9 or later.
## Install Component
The installation method is the same as [installing a theme](https://fixit.lruihao.cn/documentation/installation/). There are several ways to install, choose one, for example, install through Hugo Modules:
```diff
[module]
[[module.imports]]
path = "github.com/hugo-fixit/FixIt"
+ [[module.imports]]
+ path = "github.com/hugo-fixit/shortcode-docs-bookmark"
```## Inject Partial
Inject the `fixit-docs-bookmark.html` into the `custom-head` through the custom block opened by the FixIt theme in the `layouts/partials/custom.html` file:
```go-html-template
{{- define "custom-head" -}}
{{- partial "inject/fixit-docs-bookmark.html" . -}}
{{- end -}}
```## Use Shortcode
Here is an example of usage:
```markdown
{{< fixit-docs-bookmark >}}
```