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

Use asciidoc to document new pages #58

Open
vinipsmaker opened this issue Jul 29, 2021 · 4 comments
Open

Use asciidoc to document new pages #58

vinipsmaker opened this issue Jul 29, 2021 · 4 comments

Comments

@vinipsmaker
Copy link
Contributor

So Boost.Predef already uses asciidoc to document stuff: https://github.com/boostorg/predef/blob/caa0627ab5518333d8c0f272667140c793adca1d/doc/build.jam#L8

Could we use asciidoc from now on too? Current docs kind of stalled already, so I guess it's not very “fun” to touch QuickBook. Maybe asciidoc helps.

@breese
Copy link
Owner

breese commented Jul 31, 2021

Yes.

In fact, I started converting the documentation to asciidoc four years ago, but never completed it due to time constraints.

@lemosjose
Copy link

I see it's still open, you can send the unfinished asciidoc files and i can finish then and start moving things to a antora documentation, i think it would be better to use it, since it's the recommended by asciidoctor and includes a pretty good UI already by default.

@vinipsmaker
Copy link
Contributor Author

@breese, @lemosjose has been helping me with docs infra in a project of mine. You can see a live example of the Antora he mentioned at https://emilua.gitlab.io/docs/.

@breese
Copy link
Owner

breese commented Dec 31, 2022

I have pushed my initial conversion to the branch feature/asciidoc.

I do not recall exactly how much was done, but I suspect very little.

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

No branches or pull requests

3 participants