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.

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

[Bug] markdown content not updating with esbuild/cache enabled. #65

Closed
R-Bower opened this issue Jun 14, 2023 · 3 comments
Closed

[Bug] markdown content not updating with esbuild/cache enabled. #65

R-Bower opened this issue Jun 14, 2023 · 3 comments
Assignees
@skoropadas
Labels
Status: Released Type: Bug Something isn't working

Comments

@R-Bower
Copy link

R-Bower commented Jun 14, 2023 •
edited

Is this a regression?

Yes

Description

Reproduction:

  1. Set angularBuilder: "esbuild",
  2. Set cache: true,
  3. Start in dev mode.
  4. Change a page's markdown content.
  5. ng-doc seems to recompile the page, but when the app reloads the updates aren't applied.

Please provide the exception or error you saw

No response

OS

macOS

Browser

Chrome

Node version

18.14.0

Anything else?

This is on the freshly released Angular 16.1.0, but I recall seeing this problem a week or so ago as well.
@R-Bower R-Bower added the Type: Bug Something isn't working label Jun 14, 2023
@skoropadas
Copy link
Member

I've fixed such a bug a few releases ago but check it again with the latest Angular thank you!

@skoropadas
Copy link
Member

Interesting problem, it seems that esbuild doesn't want to detect changes in the project root for some reason, but if I move the .ng-doc folder inside the application directory, everything starts working correctly.

I think this is not an issue with NgDoc but rather with the experimental builder, but I will add an option to configure the path for the compiled modules folder so that you can move it inside your application and make everything work.

After adding the option, remember that you will also need to do the following:

  • Change the path to the @ng-doc/generated directory in tsconfig.json
  • Change the path to the .ng-doc/app-name/assets folder in angular.json

skoropadas pushed a commit that referenced this issue Jun 14, 2023
@semantic-release-bot
chore(release): 16.6.0 [skip ci]
04ac312 
# [16.6.0](v16.5.1...v16.6.0) (2023-06-14)

### Bug Fixes

* **app:** decorators in API pages are displayed without a gap ([e697bd0](e697bd0))

### Features

* **app:** the copy button in the code block is now visible only when you hover the cursor ([18fae7e](18fae7e))
* **builder:** add lines highlighter. You can use this feature to highlight any line of code inside your code blocks ([66bd91f](66bd91f))
* **builder:** add option to change the output folder for the documentation application ([4069b47](4069b47)), closes [#65](#65)
* **builder:** builder adds lines to the code blocks ([c3cefcb](c3cefcb))
@skoropadas
Copy link
Member

🎉 This issue has been resolved in version 16.6.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@skoropadas skoropadas

Labels
Status: Released Type: Bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@R-Bower @skoropadas