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

Version 0.1.0 roadmap #1

Closed
6 of 7 tasks
johnnychen94 opened this issue Aug 12, 2019 · 1 comment
Closed
6 of 7 tasks

Version 0.1.0 roadmap #1

johnnychen94 opened this issue Aug 12, 2019 · 1 comment

Comments

@johnnychen94
Copy link
Member

johnnychen94 commented Aug 12, 2019

This package is developed to replace the current demo page of https://juliaimages.org/latest/demos/

The "new" demo page is expected to be:

  • easy to deploy; seamlessly integrate with Documenter.jl and Literate.jl
  • easy to write; demo authors (not necessary package maintainers) only need to provide a single file (with assets) with no need to understand the entire documentation mechanism.
  • CI supported;

Roadmap:

  • functionalities
    • decouple {demo_image}, {demo_title} and {demo_file}; currently they're of the same name.
    • integrate with Literate.jl to support CI
    • provide a default style sheet
  • beautify the demo page
    • custom sections and cards order; currently it's sorted alphabetically.
    • make a grid of demo cards; currently it's listed vertically.
  • nice to have:
    • multiple demo pages
    • simplify the card template
@johnnychen94
Copy link
Member Author

Although there're many details needed to be checked and fixed, this package is now ready to be tested by other packages.

I'd like to fully test the markdown features first, and then consider the integration with Literate.jl.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant