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

create full @magic page from readme.md #113

Open
jaeh opened this issue Feb 29, 2020 · 0 comments
Open

create full @magic page from readme.md #113

jaeh opened this issue Feb 29, 2020 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@jaeh
Copy link
Member

jaeh commented Feb 29, 2020

now that @magic supports markdown,
we can simply create a page and menu from the readme of any repository.

to achieve:

  1. add config switch ("readme: true")
  2. instead of searching for files in dir tree, just load readme.md.
  3. get all h2 and h3 and generate a deeply nested menu out of their ids and text.
  4. create a index page from the readme contents

done.

bonus:

  • add gitbadges if user has them in readme
  • try to find logo image from readme
  • try to find a menu near the top of the page for custom menu
  • the --- @State { --- comment at the top of the page exports the state, allows all settings that normally get done in app.mjs
@jaeh jaeh self-assigned this Feb 29, 2020
@jaeh jaeh added the enhancement New feature or request label Feb 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant