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 Frontmatter Title to Allow Automatic Listings #11

Closed
hacdias opened this issue Apr 19, 2023 · 2 comments · Fixed by #13
Closed

Use Frontmatter Title to Allow Automatic Listings #11

hacdias opened this issue Apr 19, 2023 · 2 comments · Fixed by #13
Assignees

Comments

@hacdias
Copy link
Member

hacdias commented Apr 19, 2023

Context: ipfs/specs#385 (comment).

Currently, the specs files do not use the title in the frontmatter, but in the file itself, which does not happen with the remaining pages. This makes generating listings harder.

Proposal is to add title and description to the frontmatter of the specs. This will allow us to automatically generate the listings of the pages, instead of keeping them manually.

{%- for post in collections.all -%}
  <li>{{ post.data.title }}</li>
{%- endfor -%}

Then, we can add a tag: ipip to the IPIPs and iterate over collections.ipips.

@hacdias
Copy link
Member Author

hacdias commented May 2, 2023

@lidel I think this is something we should really do in terms of consistency and before ipfs/specs#385. Otherwise, we can also perhaps introduce some other way of processing this in a different way such that we have access to post listings per directory. That could potentially be useful.

@lidel
Copy link
Member

lidel commented May 8, 2023

Agree, we need this for ipfs/specs#385.

@hacdias perhaps do title and description for now? <meta name="description" (..) will improve how specs are presented in search results (https://developers.google.com/search/docs/appearance/snippet).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants