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

Bibliography database for citations in user docs #308

Open
epatters opened this issue Dec 21, 2024 · 0 comments
Open

Bibliography database for citations in user docs #308

epatters opened this issue Dec 21, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request frontend TypeScript frontend and Rust-wasm integrations

Comments

@epatters
Copy link
Member

epatters commented Dec 21, 2024

In the user docs for specific logics we cite relevant books, papers, etc as further reading. The only hope for consistently formatting these references is to format them automatically from structured data.

One possible strategy, which I'm not committed to, would be have a master .bib file for the docs (preferably covering both user and dev docs to avoid duplication), then convert it to CSL-JSON during the build process, say by using pandoc:

pandoc refs.bib -f biblatex -t csljson -o refs.json

The JSON could be loaded and processed in JS as usual. To get type defs for the biblography data, we could run json-schema-to-typescript on the JSON schema for CSL-JSON.

@epatters epatters added documentation Improvements or additions to documentation enhancement New feature or request frontend TypeScript frontend and Rust-wasm integrations labels Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request frontend TypeScript frontend and Rust-wasm integrations
Projects
None yet
Development

No branches or pull requests

1 participant