Giter Site home page Giter Site logo

Feature: add post metadata about docs HOT 10 CLOSED

0-vortex avatar 0-vortex commented on July 30, 2024
Feature: add post metadata

from docs.

Comments (10)

huynhicode avatar huynhicode commented on July 30, 2024 1

For the doc metadata, you can add something like this to the top of each md file:

---
id: head-metadata
title: Head Metadata
---

I am familiar with Docusaurus and wouldn't mind taking on this issue @0-vortex @Deadreyo
Or maybe create a new issue for adding metadata? I think this issue is for blog authors specifically?

Yes this is a different issue. Here we're discussing modifying the "last updated" section to include a link to the author's profile. Maybe this issue can be renamed to be more precise.

I have created an issue: #45 and will work on adding and configuring the head metadata.

from docs.

nightknighto avatar nightknighto commented on July 30, 2024

Where exactly are these posts or articles? The docs website only displays documentation pages.

from docs.

0-vortex avatar 0-vortex commented on July 30, 2024

Where exactly are these posts or articles? The docs website only displays documentation pages.

Are you familiar with https://docusaurus.io/docs/markdown-features#front-matter ? We are using docusaurus to create the docs 🍕

from docs.

nightknighto avatar nightknighto commented on July 30, 2024

Yes I had a look on it. So you want the meta data on the "docs" pages right? What I initially understood is that there is a separate blog for posts or something.

from docs.

0-vortex avatar 0-vortex commented on July 30, 2024

Yes I had a look on it. So you want the meta data on the "docs" pages right? What I initially understood is that there is a separate blog for posts or something.

No, the issue was about making the "author" clickable as we only really have GitHub username authors - https://docusaurus.io/docs/blog#blog-post-authors sheds more light on the 2 ways to do it!

from docs.

nightknighto avatar nightknighto commented on July 30, 2024

No, the issue was about making the "author" clickable as we only really have GitHub username authors - https://docusaurus.io/docs/blog#blog-post-authors sheds more light on the 2 ways to do it!

Is this the author section you're talking about?
image
Because I can't find any other section for authors in the project https://docs.opensauced.pizza/

from docs.

huynhicode avatar huynhicode commented on July 30, 2024

For the doc metadata, you can add something like this to the top of each md file:

---
id: head-metadata
title: Head Metadata
---

I am familiar with Docusaurus and wouldn't mind taking on this issue @0-vortex @Deadreyo

Or maybe create a new issue for adding metadata? I think this issue is for blog authors specifically?

from docs.

nightknighto avatar nightknighto commented on July 30, 2024

For the doc metadata, you can add something like this to the top of each md file:

---
id: head-metadata
title: Head Metadata
---

I am familiar with Docusaurus and wouldn't mind taking on this issue @0-vortex @Deadreyo

Or maybe create a new issue for adding metadata? I think this issue is for blog authors specifically?

Yes this is a different issue. Here we're discussing modifying the "last updated" section to include a link to the author's profile.
Maybe this issue can be renamed to be more precise.

from docs.

nightknighto avatar nightknighto commented on July 30, 2024

Ok so I researched about it, and there doesn't seem to be a configurable supported way by the framework to get any more details about the author.

I've also asked on their github discussions, and got this message, which clarifies that they dont handle email adressess / profile links due to the mentioned reasons.

image

The suggested answer by the collaborator was to make an email / link field that would be manually filled by the author upon updating the page.


Issues with this solution:

  • last_update frontmatter is not supported in this version of docusaurus. Will have to update.
  • The updater/author may forget to edit the link field, leading to names having wrong links.
  • Of course the need to update a field, instead of currently just applying the content edits.
  • Will require modification of the plugin-content-docs library

from docs.

CBID2 avatar CBID2 commented on July 30, 2024

Hey @0-vortex. Any update on this?

from docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.