https://github.com/atelierarith/docstringasimage.jl
This package visualizes Julia docstrings for functions with images
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.4%) to scientific vocabulary
Keywords
Repository
This package visualizes Julia docstrings for functions with images
Basic Info
Statistics
- Stars: 16
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
DocstringAsImage.jl
This package allows us to visualize Julia docstrings as images. This feature works only in terminals that support Sixel Graphics. Internally we use Quarto and Typst to render images. We use Sixel.jl package to render generated images in your terminal.
Setup
julia> using Pkg; Pkg.add("DocstringAsImage")
To build from source, run the following commands:
sh
$ git clone https://github.com/AtelierArith/DocstringAsImage.jl.git
$ cd DocstringAsImage.jl
$ julia --project -e 'using Pkg; Pkg.instantiate()'
$ ls
Manifest.toml Project.toml README.md src
Usage
Our package exports @imgdoc macro. It works like the @doc macro.
``julia
$ julia
_
_ _ _(_)_ | Documentation: https://docs.julialang.org
(_) | (_) (_) |
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help.
| | | | | | |/ _ | |
| | || | | | (| | | Version 1.11.2 (2024-12-01)
/ |_'|||_'| | Official https://julialang.org/ release
|_/ |
julia> using DocstringAsImage julia> @imgdoc exp julia> using SpecialFunctions: zeta julia> @imgdoc zeta julia> using Distributions: Beta julia> @imgdoc Beta ```
Owner
- Name: AtelierArith
- Login: AtelierArith
- Kind: organization
- Email: contact@atelier-arith.jp
- Location: Japan
- Twitter: AtelierArith
- Repositories: 8
- Profile: https://github.com/AtelierArith
Enhance "Math meets Art"
GitHub Events
Total
- Create event: 3
- Release event: 1
- Issues event: 4
- Watch event: 15
- Issue comment event: 4
- Push event: 17
- Public event: 1
- Pull request event: 3
Last Year
- Create event: 3
- Release event: 1
- Issues event: 4
- Watch event: 15
- Issue comment event: 4
- Push event: 17
- Public event: 1
- Pull request event: 3
Committers
Last synced: about 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| SatoshiTerasaki | t****h@g****m | 21 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 1
- Average time to close issues: 1 day
- Average time to close pull requests: less than a minute
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 1
- Average time to close issues: 1 day
- Average time to close pull requests: less than a minute
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 2.0
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- terasakisatoshi (1)
- JuliaTagBot (1)
Pull Request Authors
- terasakisatoshi (2)
- dependabot[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 1 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
juliahub.com: DocstringAsImage
This package visualizes Julia docstrings for functions with images
- Documentation: https://docs.juliahub.com/General/DocstringAsImage/stable/
- License: MIT
-
Latest release: 0.1.0
published about 1 year ago