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

Hyde update should reflect unknown tags in the YAML/JSON #75

Closed
sean-parent opened this issue Aug 17, 2022 · 1 comment
Closed

Hyde update should reflect unknown tags in the YAML/JSON #75

sean-parent opened this issue Aug 17, 2022 · 1 comment

Comments

@sean-parent
Copy link
Contributor

The front matter in a Jekyll file may contain non-related tags to hyde. For example, the stlab libraries have a tag examples: that lists a set of example files to be referenced. Hyde update strips these tags. Another example is category: tags. It might be best if non-jekyl specific hyde tags themselves were name spaced so as not to conflict with other systems:

layout: function
title: at_pre_exit
owner: sean-parent
hyde:
    brief: Register the `pre_exit_handler` to be called on [`pre_exit()`](/libraries/pre_exit.hpp/f_pre_exit.html).
    tags:
      - function
    defined_in_file: pre_exit.hpp
    overloads:
      void at_pre_exit(stlab::pre_exit_handler):
        arguments:
          - description: __OPTIONAL__
            name: f
            type: stlab::pre_exit_handler
        description: Register the `pre_exit_handler` to be called on [`pre_exit()`](/libraries/pre_exit.hpp/f_pre_exit.html). The functions are called in the reverse order that they are registered.
        return: __OPTIONAL__
        signature_with_names: void at_pre_exit(stlab::pre_exit_handler f)
    namespace:
      - stlab
      - v1
@fosterbrereton
Copy link
Contributor

This issue should be resolved as of hyde v0.1.5.

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

2 participants