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

Cut the html generator #656

Closed
alandefreitas opened this issue Aug 9, 2024 · 1 comment · Fixed by #727
Closed

Cut the html generator #656

alandefreitas opened this issue Aug 9, 2024 · 1 comment · Fixed by #727
Assignees
@alandefreitas
Labels
Bug Something isn't working

Comments

@alandefreitas
Copy link
Collaborator

alandefreitas commented Aug 9, 2024 •
edited
Loading

The HTML generator is pointless, and it's always unmaintained.

Anyone can generate the adoc reference and convert it to HTML, which yields much better results.
@alandefreitas alandefreitas added the Bug Something isn't working label Aug 9, 2024
@alandefreitas alandefreitas moved this to Available in MrDocs Aug 9, 2024
@alandefreitas
Copy link
Collaborator Author

Updating the issue with Vinnie's comments:

Well you are wrong about that Alan, it is not pointless
and you cannot just "generate the adoc reference and convert it to HTML"
The point of the HTML generator is to produce unstyled HTML with proper id and class attributes, to allow the user to easily customize the result using CSS
This cannot be done with Asciidoctor
(nor Antora)
you should update the issue to reflect that while the HTML generator is not useless, it is more efficient for us to cut the feature now, finish what we have, and then when we circle back to implementing HTML we do it comprehensively

@alandefreitas alandefreitas moved this from Accepted to In progress in MrDocs Oct 28, 2024
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Nov 12, 2024
@alandefreitas
refactor: simplify handlebars generators
0edf925 
Apart from the DocVisitor, the Adoc and HTML generators are nearly 100% duplicated code.

This is main reason why the HTML Generator is always behind the Adoc Generator, as simple features were no duplicated in the HTML generator.

This commit unifies this common code to remove the duplicated code, simplify maintenance, and so that both generators always have access to the same features.

In passing, many features that were missing in the HTML generator are now implemented in this commit.

fix cppalliance#656
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Nov 12, 2024
@alandefreitas
refactor: simplify handlebars generators
d17c50a 
Apart from the DocVisitor, the Adoc and HTML generators are nearly 100% duplicated code.

This is main reason why the HTML Generator is always behind the Adoc Generator, as simple features were no duplicated in the HTML generator. This even justified cppalliance#656, where we would temporarily remove the HTML generator.

This commit unifies this common code to remove the duplicated code, simplify maintenance, and so that both generators always have access to the same features.

In passing, many features that were missing in the HTML generator are now implemented in this commit.

fix cppalliance#656
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Nov 12, 2024
@alandefreitas
refactor: simplify handlebars generators
91e0ffc 
Apart from the DocVisitor, the Adoc and HTML generators are nearly 100% duplicated code.

This is main reason why the HTML Generator is always behind the Adoc Generator, as simple features were no duplicated in the HTML generator. This even justified cppalliance#656, where we would temporarily remove the HTML generator.

This commit unifies this common code to remove the duplicated code, simplify maintenance, and so that both generators always have access to the same features.

In passing, many features that were missing in the HTML generator are now implemented in this commit.

fix cppalliance#656
@alandefreitas alandefreitas mentioned this issue Nov 12, 2024
Merged
alandefreitas added a commit to alandefreitas/mrdocs that referenced this issue Nov 12, 2024
@alandefreitas
refactor: simplify handlebars generators
4aeff2b 
Apart from the DocVisitor, the Adoc and HTML generators are nearly 100% duplicated code.

This is the main reason the HTML Generator is always behind the Adoc Generator: simple features were not duplicated in the HTML generator. This even justified cppalliance#656, where we would temporarily remove the HTML generator.

This commit unifies the standard code to remove duplicated code, simplify maintenance, and ensure that both generators always have access to the same features.

In passing, many missing features in the HTML generator are now available.

fix cppalliance#656
@github-project-automation github-project-automation bot moved this from In progress to Done in MrDocs Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alandefreitas alandefreitas

Labels
Bug Something isn't working
Projects
MrDocs
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

refactor: simplify handlebars generators alandefreitas/mrdocs
2 participants
@fpelliccioni @alandefreitas