feat(book): An online book documentation for presenterm using `mdbook`

mfontanini / presenterm

A markdown terminal slideshow tool

https://mfontanini.github.io/presenterm/

BSD 2-Clause "Simplified" License

1.19k stars 29 forks source link

feat(book): An online book documentation for presenterm using `mdbook` #127

Closed pwnwriter closed 8 months ago

pwnwriter commented 8 months ago

Hello @mfontanini,

There's so much happening that I'd like to rearrange some things to make the process smoother.

I've included a book that utilizes mdBook with the catppuccin theme alongside the default ones. Mdbook ci will run on every new push on master branch and update your docs automatically to new branch called book

Deployed here: Presenterm Netlify Deployment

I tried using GitHub Pages, but it wasn't rendering assets.

GitHub Pages deploy: Presenterm GitHub Pages Deployment

So, I suggest sticking with Netlify.

Refactored entry to prevent panics (#124)
Added dependabot to make pr on deps updates
- It'll be easy for you to manage deps as i see you were bumping them manually.

Feel free to remove or add anything; I'm open to whatever changes you think are suitable. :v:

pwnwriter commented 8 months ago

Also i'm sorry, I should have checked it before

screenshot_2024-01-10_11-40-39

You don't need to provide v0.1.2 or You can proceed with just the version eg:

./releaser.sh 0.1.2 # or soo

Seems like aliesbelik/presenterm is making a pr . i'm letting you guys make changes !

pwnwriter commented 8 months ago

Yes ! I got everything you said , I'll make changes and resolve tomorrow morning! Gotta sleep rn.

mfontanini commented 8 months ago

Another one: the links in the root README file in the repo point to various places in the docs, e.g. in the "features" section. Those should now point to /docs/src. Once this is deployed we can make them point to the mdbook but until then they should point somewhere valid.

pwnwriter commented 8 months ago

Another one: the links in the root README file in the repo point to various places in the docs, e.g. in the "features" section. Those should now point to /docs/src. Once this is deployed we can make them point to the mdbook but until then they should point somewhere valid.

I think we can streamline the home README by including only essential information and providing a direct link to the documentation?.

mfontanini commented 8 months ago

I like having the list of features showing up near the top given there's various tools that serve the same purpose but I think presenterm has more features than the rest of them so that's the big differentiator.

mfontanini commented 8 months ago

Merging this against an intermediate branch. Will make changes and merge to master once it's ready.

mfontanini commented 8 months ago

Thanks @pwnwriter !