https://github.com/mordragt/bib_kit
Provides an firefox extension to create citations in the hayagriva format used by typst
https://github.com/mordragt/bib_kit
citations hayagriva typst
Last synced: 4 months ago
JSON representation
Provides an firefox extension to create citations in the hayagriva format used by typst
- Host: GitHub
- URL: https://github.com/mordragt/bib_kit
- Owner: MordragT
- License: mit
- Created: 2023-04-16T17:33:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T15:48:36.000Z (over 2 years ago)
- Last Synced: 2025-04-13T15:05:50.165Z (7 months ago)
- Topics: citations, hayagriva, typst
- Language: Rust
- Homepage:
- Size: 359 KB
- Stars: 18
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bib Kit - Hayagriva Extension for Firefox 📚
This extension allows retrieving website information to create
citations in the `hayagriva` format.
## Warning
This extension is highly experimental. Bugs are expected.
If you encounter any feel free to create issues.
I do not recommend using the extension at this state.
If you are curious however what is working so far you can install
the extension [here](https://addons.mozilla.org/en-US/firefox/addon/bib-kit/)
## Screenshot
## Roadmap
- [ ] create more data extractors (e.g. dublin-core)
- [ ] better error handling (expose errors better to javascript)
- [ ] better data validation
## Building
#### With Nix
When you have the nix package manager installed you can just go into the root directory of this project and follow these instructions:
1. Run `nix develop` to create a shell with all necessary programs and dependencies
2. Go into the `html-meta` directory and run `just build`
3. Go back to the main directory and run `just build`
4. The extension should be built inside the `build` directory
#### Other Platforms
Install the following packages on your system:
- `just`: Task runner similar to make
- `wasm-pack`: Used to create the wasm bindings
- `web-ext`: Used to build the extension
- `cargo`: Rust's package manager and build tool
Make sure your Rust installation is able to target `wasm32-unknown-unknown`
1. Go into the `html-meta` directory and run `just build`
2. Go back to the main directory and run `just build`
3. The extension should be built inside the `build` directory
## License
The icon made by Iconsax and all the source code is published under the MIT license.
## References
- [Hayagriva](https://github.com/typst/hayagriva) - the citation format
- [Typst](https://github.com/typst/typst) - a new markup-based typesetting format
## Acknowledgements
- [Icon](https://www.svgrepo.com/svg/495072/book-square) - made by Iconsax