https://github.com/bonsai-rx/docfx-tools
The standard docfx template for package documentation
Science Score: 36.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
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 4 committers (25.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (7.9%) to scientific vocabulary
Repository
The standard docfx template for package documentation
Basic Info
- Host: GitHub
- Owner: bonsai-rx
- License: mit
- Language: PowerShell
- Default Branch: main
- Size: 67.4 KB
Statistics
- Stars: 0
- Watchers: 3
- Forks: 6
- Open Issues: 15
- Releases: 0
Metadata Files
README.md
docfx-tools
A docfx template for package documentation, patching the modern template to provide stylesheets and scripts for rendering custom workflow containers with copy functionality.
How to use
To include this template in a docfx website, first clone this repository as a submodule:
git submodule add https://github.com/bonsai-rx/docfx-tools bonsai-docfx
Then modify docfx.json to include the template immediately after the modern template:
json
"template": [
"default",
"modern",
"bonsai-docfx/template",
"template"
],
Finally, import and call the modules inside your website template/public folder.
main.css
css
@import "bonsai.css";
main.js
```js import WorkflowContainer from "./workflow.js"
export default { start: () => { WorkflowContainer.init(); } } ```
Powershell Scripts
This repository also provides helper scripts to automate several content generation steps for package documentation websites.
Exporting workflow images
Exporting SVG images for all example workflows can be automated by placing all .bonsai files in a workflows folder and calling the below script pointing to the bin directory to include. A bonsai environment is assumed to be available in the .bonsai folder in the repository root.
ps1
.\modules\Export-Image.ps1 "..\src\PackageName\bin\Release\net472"
Owner
- Name: Bonsai
- Login: bonsai-rx
- Kind: organization
- Website: bonsai-rx.org
- Repositories: 13
- Profile: https://github.com/bonsai-rx
A visual language for reactive programming
GitHub Events
Total
- Issues event: 11
- Delete event: 5
- Issue comment event: 30
- Push event: 6
- Pull request review event: 3
- Pull request event: 14
- Fork event: 4
- Create event: 3
Last Year
- Issues event: 11
- Delete event: 5
- Issue comment event: 30
- Push event: 6
- Pull request review event: 3
- Pull request event: 14
- Fork event: 4
- Create event: 3
Committers
Last synced: 12 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| glopesdev | g****v | 22 |
| lochhh | c****o@u****k | 1 |
| Luís Teixeira | m****a@g****m | 1 |
| David Maas | d****t@n****g | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 4
- Total pull requests: 8
- Average time to close issues: 3 months
- Average time to close pull requests: 17 days
- Total issue authors: 2
- Total pull request authors: 5
- Average comments per issue: 0.0
- Average comments per pull request: 1.13
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 4
- Pull requests: 8
- Average time to close issues: 3 months
- Average time to close pull requests: 17 days
- Issue authors: 2
- Pull request authors: 5
- Average comments per issue: 0.0
- Average comments per pull request: 1.13
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- banchan86 (9)
- MicBoucinha (1)
- glopesdev (1)
- cjsha (1)
Pull Request Authors
- banchan86 (5)
- glopesdev (5)
- lochhh (1)
- PathogenDavid (1)
- cjsha (1)
- MicBoucinha (1)