Skip to content

feat: documentation templateΒ #220

@danielhe4rt

Description

@danielhe4rt

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions