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

[timeline] Option to generate timeline from files in a folder #44

Open
Andre601 opened this issue Aug 30, 2023 · 0 comments
Open

[timeline] Option to generate timeline from files in a folder #44

Andre601 opened this issue Aug 30, 2023 · 0 comments

Comments

@Andre601
Copy link

It would be really cool if you could configure the timeline plugin to generate a timeline based on files in a folder.
That way could you easily add more content (Maybe even with more formatting through markdown) without having to constantly extend the ::timeline:: ... ::/timeline:: placeholder.

Perhaps the plugin could use certain frontmatter and/or page values for the different options?

For example:

---
timeline:
  title: 'title' # If not present defaults to {{ page.title }}
  sub_title: 'Q1 2023' # Maybe use H1 header?
  icon: ':simple-github:' # Could default to Mkdocs-material's icon option?
---

# Page

Lorem Ipsum

would be equivalent to

::timeline::
[
  {
    "title": "title",
    "icon": ":simple-github:",
    "sub_title": "Q1 2023",
    "content": "Lorem Ipsum"
  }
]
::/timeline::

To define it, a folder option could be added:

::timeline:: folder=".profiles"

::/timeline::

This would search for a profiles folder relative to its own position...

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

1 participant