Better documentations#18
Conversation
✅ Deploy Preview for blazorstatic ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
I tried to keep the main Readme as simple and straightforward as possible. |
tesar-tech
left a comment
There was a problem hiding this comment.
Nice. This is a much better version. It is not an easy task to explain things to people from the position of someone who understands it well. Thanks for the contribution.
| It automatically discovers pages to generate by scanning for the `@page` directive in Razor files, but It only targets non-parametrized pages (e.g., `@page "/mypage"`, not `@page "/mypage/{param}"`). | ||
|
|
||
| BlazorStatic is a small library designed for integration into Blazor applications. Here are a few straightforward methods to get started: | ||
| ### Features |
There was a problem hiding this comment.
Also second level heading here? ##
| ### Features | ||
|
|
||
| ### Fork or clone BlazorStaticMinimalBlog | ||
| - Easily parse and consume markdown files. |
There was a problem hiding this comment.
I like how brief and on point it is!
| app.UseBlazorStaticGenerator(shutdownApp: !app.Environment.IsDevelopment()); | ||
| ``` | ||
| - `shutdownApp` is essential for CI/CD pipelines to prevent indefinite running. | ||
| #### Cloning the project |
There was a problem hiding this comment.
I wouldn't put this in main "how to" guide. It makes it look complicated.
|
It just occured to me, Should I add a "limitations" section below the features? |
Hm, probably yes, some sort of.. But what are the limitations? Limitations of static site generator in general? Limitations like "missing features"? I would name it in more positive manner, something like: "Coming soon", etc.. |
|
I meant like a warning to inform users that this library cannot convert their c# code to JavaScript, so if they have any interactive component that relies on c# it won't work. |
|
I think it's not necessary. This is already an "issue" with SSR and people who are willing to use any static site generator do understand that. |
|
Thanks for it. I have done some edits after. |
clean and improve the documentations
TODO
in-depth-guide?)is there anything else i forgot about?