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

added header synopses to the reference #303

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

joaquintides
Copy link
Member

Added header synopses to the reference in the style of the standard. Solves #301.

@cppalliance-bot
Copy link

An automated preview of the documentation is available at https://303.unordered.prtest2.cppalliance.org/libs/unordered/doc/html/index.html

* xref:reference/unordered_set.adoc[unordered_set]
* xref:reference/unordered_multiset.adoc[unordered_multiset]
* xref:reference/hash_traits.adoc[hash_traits]
* xref:reference/header_unordered_map_fwd.adoc[`<boost/unordered/unordered_map_fwd.hpp>` Synopsis]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try putting the code backticks on the outside of the xref and tell me if you like how it looks.

image

In this image, the top two links are the updated version. The third one is the current look.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can solve this in a more satisfactory way, for that I'd need for you to add this definition to the source site.css:

.inlink-code {
    font-family: Roboto Mono,monospace;
    font-size: 95%;
    color: inherit;
}

Can you do that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course. You can do that locally yourself even.

All you gotta clone is the unordered-ui-bundle repo and then invoke gulp bundle in it. There's docs here: https://gitlab.com/antora/antora-ui-default#user-content-development-quickstart

@cmazakas
Copy link
Member

I really like these changes but we'll probably have to update the UI bundle.

Consider:
image

The reference is awfully cramped here on my screen.

I did a width adjustment in the CSS and this is how it looks now:
image

Let me know what you think. It's kind of nice how much we can really fine tune here.

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.

3 participants