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

feat: documentation template #220

Open
danielhe4rt opened this issue Jan 31, 2025 · 0 comments
Open

feat: documentation template #220

danielhe4rt opened this issue Jan 31, 2025 · 0 comments

Comments

@danielhe4rt
Copy link

Hey everyone!

Thanks for the amazing project being shipped! I saw it a month ago in Bluesky and yesterday I was doing a PoC with new static documentation generation tools, but none of them got me in terms simplicity like Marmite did. So, I have a request to do here: it's a possibility to generate documentations with Marmite?

Feature

Currently, we have Docusaurus with a really good boilerplate to use, which follows the same concept of MDX.

---
sidebar_position: 1
label: 'Getting Started'
icon: 'heroicon-amazing-icon'
---

# Welcome

... your content here...

or instead a config file for the UI to replace the properties is placed inside any folder for category related props:

{
  "label": "Getting Started",
  "icon": "heroicon-amazing-icon",
  "position": 3,
  "link": {
    "type": "generated-index"
  }
}

with that, I would easily adopt Marmite to my personal documentation projects...

Warning

I'm just opening it because I chatted with Bruno earlier about the possibility.

Anyway, thanks for your contributions and I'm excited to see what would come up from this issue.

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