{"id":16897056,"url":"https://github.com/bytesnake/mdbook-scientific","last_synced_at":"2025-04-11T13:42:00.680Z","repository":{"id":53451743,"uuid":"256467526","full_name":"bytesnake/mdbook-scientific","owner":"bytesnake","description":"A plugin for scientific mdbooks","archived":false,"fork":false,"pushed_at":"2022-12-13T09:01:23.000Z","size":40,"stargazers_count":14,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2023-03-13T00:01:05.900Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bytesnake.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-17T10:03:49.000Z","updated_at":"2022-12-13T09:06:05.000Z","dependencies_parsed_at":"2023-01-28T10:00:15.049Z","dependency_job_id":null,"html_url":"https://github.com/bytesnake/mdbook-scientific","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fmdbook-scientific","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fmdbook-scientific/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fmdbook-scientific/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bytesnake%2Fmdbook-scientific/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bytesnake","download_url":"https://codeload.github.com/bytesnake/mdbook-scientific/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219851579,"owners_count":16556238,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T17:34:36.055Z","updated_at":"2024-10-13T17:34:36.544Z","avatar_url":"https://github.com/bytesnake.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Scientific mdbook plugin\nThis plugin adds functionality to `mdbook` for scientific application. It allows the writer to generate named LaTeX, named Gnuplots and supports `bibtex` files. Further cross-referencing in text to equation, figures or literature is possible. A sample output can be seen [here](https://bytesnake.github.io/mdbook_example/).\n\n## Install\n\nCompile this crate and add the `mdbook-scientific` to your search path. Also [bib2xhtml](https://github.com/dspinellis/bib2xhtml) is required if you want to generate a bibliography. Then add the following to your `book.toml`:\n```\n[preprocessor.scientific]\nrenderer = [\"html\"]\n\nbibliography = \"literature.bib\"\nbib2xhtml = \"/home/lorenz/Documents/tmp/bib2xhtml/\"\n\nassets = \"src/\"\n\n[output.html]\nadditional-css = [\"src/scientific.css\"]\n```\n\nFor latex rendering `latex` and `dvisvgm` are required. For gnuplot rendering the `gnuplot` binary.\n\n## Syntax\n\nFor block equation rendering use the following syntax\n\n```\n$$equation, \u003cname\u003e\n...\n$$\n```\n\nthe `equation` identifier is only needed if you want to name the equation block. You can cross-reference it then with `$ref:equ:\u003cname\u003e$` in the whole `mdbook`.\n\nThe same syntax is working with `latex` and `gnuplot` figures, both are requiring a subtitle for the plot. Further a `gnuplotonly` figure only uses Gnuplot to render the file to SVG.\n\nExample for gnuplot rendering\n```\n$$gnuplot, \u003cname\u003e, \u003csubtitle\u003e\n...\n$$\n```\nand then cross-reference with `$ref:fig:\u003cname\u003e$`.\n\nIf block is empty, then the preprocessor looks into the `assets` path specified in the configuration. So for a block `$$latex, legendrepoly, Legendre Polynomials$$` it looks for the file `src/legendrepoly.tex`.\n\nThe BibTeX file referenced in the configuration file is added as a additional chapter and citations can be generated with `$ref:bib:\u003cname\u003e$`.\n\n## Should I use this\nNope, it's still in its infancy. Please don't use it yet. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytesnake%2Fmdbook-scientific","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbytesnake%2Fmdbook-scientific","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbytesnake%2Fmdbook-scientific/lists"}