ShowTheDocs/content.json at main · zonaro/ShowTheDocs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
    "title": "Show The Docs!",
    "description": "FlatFile Documentation Generator",
    "datelabel": "Updated",
    "social": [
        {
            "name": "Github",
            "icon": "fa fa-github",
            "url": "http://github.com/zonaro"
        }
    ],
    "logo": "https://place-hold.it/200x100?text=ShowTheDocs",
    "downloadbutton": "http://github.com/zonaro/ShowTheDocs",
    "viewraw": "See the original file",
    "copydialog": "Press CTRL+C to Copy",
    "copytoast": "Link copied to clipboard!",
    "content": [
        {
            "id": "1",
            "icon": "fas fa-file",
            "title": "Show The Docs",
            "date": "16/01/2026",
            "contentfile": "README.md"
        },
        {
            "id": "1.1",
            "icon": "fas fa-paper-plane",
            "title": "Getting Started",
            "date": "26/09/2022",
            "contentfile": "getting_started.md"
        },
        {
            "id": "1.2",
            "icon": "fas fa-share",
            "date": "22/09/2022",
            "title": "Generate a documentation",
            "content": "Now just go to http://zonaro.github.io/ShowTheDocs/#/YourUserName/YourRepo/DocBranch to see the generated documentation.",
            "alerts": [
                {
                    "type": "Info",
                    "label": "Tip",
                    "content": "You can also, specify the `basePath` parameter with absolute path to your json istead of /#/YourUserName/YourRepo/DocBranch."
                },
                {
                    "type": "warning",
                    "label": "Warn",
                    "content": "When using the `basePath` parameter, all image and link paths in this json must be absolute."
                }
            ]
        },
        {
            "id": "1.3",
            "icon": "fas fa-person",
            "date": "16/01/2026",
            "title": "Credits",
            "contentfile": "credits.md"
        }
    ]
}