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

Thoughts on bundling raw markdown and shipping a compiler in development? #95

Open
NullVoxPopuli opened this issue May 7, 2021 · 7 comments

Comments

@NullVoxPopuli
Copy link
Contributor

I'm noticing that with enough documentation, initial build can be > 3 minutes, and rebuilds > 20s.

What if, during development (or maybe always?), we ship the compiler, and dynamically load the markdown files as the pages are visited.
During build, the only data kept in the main bundle would be the frontmatter info / references to the uncompiled markdown files.

@josemarluedke
Copy link
Owner

Is the build time due to Ember or Docfy specifically? I would probably guess this is because of Ember build pipeline. Probably using Embroider + Vite would improve the experience (I think). Embroider support is also not fully fleshed out...

Docfy does need to do a partial build. Today, we build everything at every change. This is because of the nature of linking between files, so we should create a caching layer.

@NullVoxPopuli
Copy link
Contributor Author

Is the build time due to Ember or Docfy specifically?

How do I find out where time is spent during build?

@NullVoxPopuli
Copy link
Contributor Author

Today initial build is ~ 300,000ms

@NullVoxPopuli
Copy link
Contributor Author

@NullVoxPopuli
Copy link
Contributor Author

Today, initial build is ~ 530s

@NullVoxPopuli
Copy link
Contributor Author

oh I almost have the same issue open twice, related comment: #85 (comment)

@NullVoxPopuli
Copy link
Contributor Author

NullVoxPopuli commented Sep 30, 2021

as I'm digging in to this, it seems it would be easier to, instead of having to upgrade a bunch of things for ember-auto-import@v2 compatibility, to not use the docfy-plugin that dumps the docs to components, and then override the docfy service and docfy-output component to handle async (fetching + rendering). New issue incoming: #113

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

2 participants