This package is used to dynamically generate a demo page and integrate with Documenter.jl.
Let's focus on writing demos
- a plugin package to
Documenter.jlto manage all your demos.
- folder structure is the demo structure.
- minimal configuration.
- CI friendly
- support demos in markdown and julia format.
The philosophy of DemoCards is "folder structure is the structure of demos"; organizing folders and files in
the a structural way, then
DemoCards.jl will help manage how you navigate through the pages.
examples ├── part1 │ ├── assets │ ├── demo_1.md │ ├── demo_2.md │ └── demo_3.md └── part2 ├── demo_4.jl └── demo_5.jl
DemoCards would understand it in the following way:
# Examples ## Part1 demo_1.md demo_2.md demo_3.md ## Part2 demo_4.jl demo_5.jl
Read the Quick Start for more instructions.
The initial purpose of this package is to set up the demo page of JuliaImages. I'm not sure how broadly this package suits the need of others, but I'd like to accept any issues/PRs on improving the usage experience.