Skip to content

Export ABP documentation as PDF/Markdown #16792

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

Open
hikalkan opened this issue Jun 8, 2023 · 4 comments · May be fixed by #22430
Open

Export ABP documentation as PDF/Markdown #16792

hikalkan opened this issue Jun 8, 2023 · 4 comments · May be fixed by #22430

Comments

@hikalkan
Copy link
Member

hikalkan commented Jun 8, 2023

Implementation Notes

  • This will be done in the docs module and will be independent of ABP documentation.
  • We can start with markdown first. We can merge all documents into a single Markdown file. Then we can convert this to PDF later. We can allow it to download as MD or PDF.
  • Use the docs-nav.json file as the source, go to the documents one by one and create a single MD file.
  • One problem: Some documents (example) have multiple options (UI and DB, mostly). For this documents, they system should place the document multiple times, each for a specific configuration. Example: The resulting single MD file should contain these titles: "TODO Application Tutorial with Single-Layer Solution (Angular, Entity Framework Core)", "TODO Application Tutorial with Single-Layer Solution (MVC / Razor Pages, MongoDB)". For this tutorial, we will have 8 copies in the resulting file with different titles (same title, but with different parathesis).
  • Another problem: Some documents may not included in docs-nav.json file. They are linked inside a module and no direct way to access thought the navigation menu. As a solution, I offer to add all them to the docs-nav.json file, but with an optional
    "hidden": "true" property. So, this is a new property (default value is false, if not defines) and the docs module should check it and skip that item while rendering on the menu. So, it is a backward compatible new feature for the docs module.
  • Another problem: We may have some items on the docs-nav file, but we may want to exclude them from the PDF file. For example, no need to include https://abp.io/docs/latest/kb/index . For these items, define a new optional property "ignoreOnDownload": "true" (default: false, if not defined). We can ignore these kind of documents.
@hitaspdotnet
Copy link
Contributor

hitaspdotnet commented Jun 27, 2023

The navigation is table of content, and the rendered outputs are contents with simple theme for header/footer.
A downloadable version of all documents which hosted in the document's source and generate at project creating, and a client-side download-as-pdf per document page for managing bandwidth and hardware resources using html to pdf.

@hikalkan hikalkan modified the milestones: backlog, 9.2-preview Feb 12, 2025
@hikalkan hikalkan assigned realLiangshiwei and unassigned maliming Feb 12, 2025
@hikalkan hikalkan changed the title Export ABP documentation as PDF Export ABP documentation as PDF/Markdown Feb 12, 2025
@hikalkan
Copy link
Member Author

Talk to @ebicoglu to decide where to download that. Maybe on the admin side of the docs module.

@ebicoglu
Copy link
Member

ebicoglu commented Feb 21, 2025

@realLiangshiwei I created an MVP for this. you can start your project with this repo https://github.com/ebicoglu/abp-support-chat-bot/tree/main --> moved to --> https://github.com/volosoft/vs-internal/tree/dev/others/abp-chat-bot

@ebicoglu
Copy link
Member

@realLiangshiwei I created an MVP for this. you can start your project with this repo https://github.com/ebicoglu/abp-support-chat-bot/tree/main

I moved the sample to here => https://github.com/volosoft/vs-internal/tree/dev/others/abp-chat-bot

@hikalkan hikalkan modified the milestones: 9.2-preview, 9.3-preview Mar 21, 2025
@realLiangshiwei realLiangshiwei linked a pull request Mar 24, 2025 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants