Thanks to visit codestin.com
Credit goes to github.com

Skip to content

RFC: Using Scully #2240

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.

Sign up for GitHub

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

Jump to bottom
Closed
1 of 5 tasks
BrunnerLivio opened this issue Mar 9, 2022 · 3 comments
Closed
1 of 5 tasks

RFC: Using Scully #2240

BrunnerLivio opened this issue Mar 9, 2022 · 3 comments

Comments

@BrunnerLivio
Copy link
Member

I'm submitting a...

  • Regression
  • Bug report
  • Feature request
  • Documentation issue or request (new chapter/page)
  • Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

At the moment we have to maintain components which use auto-generated HTML from Markdown files.
On top of that the router needs to be configured using the NgRouter.

Expected behavior

Scully would allow to easily transform MD into HTML, while also dynamically generate the routes & navigation.

What is the motivation / use case for changing the behavior?

Easier to maintain the docs + potentially enables #413
@BrunnerLivio
Copy link
Member Author

TBH I haven’t tried out Scully myself. It seems less mature than GastbyJS or NextJS, but it may suffice for this documenation.

Nonetheless, if you’d see benefit in using it I could explore the possibilites and setup a draft PR.

@jmcdo29
Copy link
Member

jmcdo29 commented Mar 9, 2022

Another option would be a tool like astro (working on using it for my ogma documentation) and it can use Vue and react components during compilation while using the minimal amount of JS in the final build

@kamilmysliwiec
Copy link
Member

Given that the application (docs app) already exists and is in pretty good shape, are we sure there's a viable reason to invest so much time to basically migrate to another tool? I feel like at this point this would be just a waste of time TBH

@Tony133 Tony133 mentioned this issue Jun 5, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@BrunnerLivio @kamilmysliwiec @jmcdo29