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

Regenerated readme.html from readme.md #97

Merged

Conversation

guusdk
Copy link
Member

@guusdk guusdk commented Apr 13, 2022

The HTML version of the readme was seriously lagging behind the Markdown version. This commit brings both back in sync.

To generate the HTML version, I took the Markdown version, which I added to the webapp of https://stackedit.io/

Next, I exported the stackedit-generated page as HTML, using their "Stylized HTML with TOC" template.

I've only changed the HTML title in the generated file.

The HTML version of the readme was seriously lagging behind the Markdown version. This commit brings both back in sync.

To generate the HTML version, I took the Markdown version, which I added to the webapp of https://stackedit.io/

Next, I exported the stackedit-generated page as HTML, using their "Stylized HTML with TOC" template.

I've only changed the HTML title in the generated file.
@guusdk guusdk requested a review from Redor April 13, 2022 08:09
@Redor
Copy link
Contributor

Redor commented Apr 13, 2022

That is exactly how I did it in the past. In the future, we might need to think about an automated way. Maybe just swagger reference, or generate HTML out MD.

@Redor Redor merged commit 315922b into igniterealtime:master Apr 13, 2022
@guusdk
Copy link
Member Author

guusdk commented Apr 13, 2022

In the future, we might need to think about an automated way.

I have raised #71 for this.

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

Successfully merging this pull request may close these issues.

2 participants